From: Luc Teirlinck Date: Tue, 20 Dec 2005 03:08:11 +0000 (+0000) Subject: (Documentation Tips): Update for new conventions for using `*' in docstrings. X-Git-Tag: emacs-pretest-22.0.90~5178 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=eef4e174d80fd67a90d5bbbee56a05c2bea8dd1e;p=emacs.git (Documentation Tips): Update for new conventions for using `*' in docstrings. --- 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