Mercurial > emacs
comparison lispref/tips.texi @ 67686:a99220d00c05
(Documentation Tips): Update for new conventions for using `*' in docstrings.
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Tue, 20 Dec 2005 03:08:11 +0000 |
parents | 62934d7c890f |
children | f5914f5bfb9c |
comparison
equal
deleted
inserted
replaced
67685:513f9a21b460 | 67686:a99220d00c05 |
---|---|
638 first paragraph of its documentation string---everything through the | 638 first paragraph of its documentation string---everything through the |
639 first blank line. If you wish, you can choose which information to | 639 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 |
651 start with words such as ``Non-nil means@dots{}'', to make it clear that | 650 start with words such as ``Non-nil means@dots{}'', to make it clear that |
652 all non-@code{nil} values are equivalent and indicate explicitly what | 651 all non-@code{nil} values are equivalent and indicate explicitly what |