mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-25 23:10:47 -08:00
Code Issues Projects Releases Wiki Activity

(Documentation Tips): Update for new conventions for using `*' in docstrings.

Browse source
This commit is contained in:
Luc Teirlinck 2005-12-20 03:08:11 +00:00
parent 77df907a15
commit eef4e174d8
1 changed files with 4 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lispref/tips.texi
View 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