Mercurial > emacs
changeset 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 | 513f9a21b460 |
| children | 4398adcb45e8 |
| files | lispref/tips.texi |
| diffstat | 1 files changed, 4 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/tips.texi Tue Dec 20 03:07:04 2005 +0000 +++ b/lispref/tips.texi Tue Dec 20 03:08:11 2005 +0000 @@ -640,11 +640,10 @@ include before the first blank line so as to make this display useful. @item -A variable's documentation string should start with @samp{*} if the -variable is one that users would often want to set interactively. If -the value is a long list, or a function, or if the variable would be set -only in init files, then don't start the documentation string with -@samp{*}. @xref{Defining Variables}. +When you define a variable that users ought to set interactively, you +should normally use @code{defcustom}. However, if for some reason you +use @code{defvar} instead, start the doc string with a @samp{*}. +@xref{Defining Variables}. @item The documentation string for a variable that is a yes-or-no flag should