]> git.eshelyaron.com Git - emacs.git/commitdiff
(Documentation Tips): Update for new conventions for using `*' in docstrings.
authorLuc Teirlinck <teirllm@auburn.edu>
Tue, 20 Dec 2005 03:08:11 +0000 (03:08 +0000)
committerLuc Teirlinck <teirllm@auburn.edu>
Tue, 20 Dec 2005 03:08:11 +0000 (03:08 +0000)
lispref/tips.texi

index ee2a7ba83e0d3df01f61ccf12bb188f3a229967d..1e12000956fd588bdbb1abe7822735704cba8260 100644 (file)
@@ -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