diff options
author | Luc Teirlinck <teirllm@auburn.edu> | 2005-12-20 03:08:11 +0000 |
---|---|---|
committer | Luc Teirlinck <teirllm@auburn.edu> | 2005-12-20 03:08:11 +0000 |
commit | 2a233a700e0b8d8f288e5fb76e1c7d429a28930c (patch) | |
tree | 34491e1e2d9c07a7cf0b63b407e3a7982d229b0d /lispref | |
parent | 674da0dc1dd367dc4f41d2e2996625fb598807cf (diff) | |
download | emacs-2a233a700e0b8d8f288e5fb76e1c7d429a28930c.tar.gz |
(Documentation Tips): Update for new conventions for using `*' in docstrings.
Diffstat (limited to 'lispref')
-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 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 |