aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuc Teirlinck2005-12-20 03:08:11 +0000
committerLuc Teirlinck2005-12-20 03:08:11 +0000
commiteef4e174d80fd67a90d5bbbee56a05c2bea8dd1e (patch)
tree0803699cd2cd92615e99e5fa9726baef54d5d28b
parent77df907a15ae0bcee53006063d794cac04be61d8 (diff)
downloademacs-eef4e174d80fd67a90d5bbbee56a05c2bea8dd1e.tar.gz
emacs-eef4e174d80fd67a90d5bbbee56a05c2bea8dd1e.zip
(Documentation Tips): Update for new conventions for using `*' in docstrings.
-rw-r--r--lispref/tips.texi9
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
640include before the first blank line so as to make this display useful. 640include before the first blank line so as to make this display useful.
641 641
642@item 642@item
643A variable's documentation string should start with @samp{*} if the 643When you define a variable that users ought to set interactively, you
644variable is one that users would often want to set interactively. If 644should normally use @code{defcustom}. However, if for some reason you
645the value is a long list, or a function, or if the variable would be set 645use @code{defvar} instead, start the doc string with a @samp{*}.
646only 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
650The documentation string for a variable that is a yes-or-no flag should 649The documentation string for a variable that is a yes-or-no flag should