diff options
| -rw-r--r-- | lispref/tips.texi | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index ee2a7ba83e0..1e12000956f 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi | |||
| @@ -640,11 +640,10 @@ first blank line. If you wish, you can choose which information to | |||
| 640 | include before the first blank line so as to make this display useful. | 640 | include before the first blank line so as to make this display useful. |
| 641 | 641 | ||
| 642 | @item | 642 | @item |
| 643 | A variable's documentation string should start with @samp{*} if the | 643 | When you define a variable that users ought to set interactively, you |
| 644 | variable is one that users would often want to set interactively. If | 644 | should normally use @code{defcustom}. However, if for some reason you |
| 645 | the value is a long list, or a function, or if the variable would be set | 645 | use @code{defvar} instead, start the doc string with a @samp{*}. |
| 646 | only in init files, then don't start the documentation string with | 646 | @xref{Defining Variables}. |
| 647 | @samp{*}. @xref{Defining Variables}. | ||
| 648 | 647 | ||
| 649 | @item | 648 | @item |
| 650 | The documentation string for a variable that is a yes-or-no flag should | 649 | The documentation string for a variable that is a yes-or-no flag should |