Mercurial > emacs
changeset 39165:27db1f1aac19
Correct the statement of when to use * in variable doc strings.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Thu, 06 Sep 2001 19:43:44 +0000 |
| parents | ecf35d2638f4 |
| children | f0bfa8a7d472 |
| files | lispref/variables.texi |
| diffstat | 1 files changed, 7 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/variables.texi Thu Sep 06 19:41:11 2001 +0000 +++ b/lispref/variables.texi Thu Sep 06 19:43:44 2001 +0000 @@ -452,12 +452,13 @@ stored in the symbol's @code{variable-documentation} property. The Emacs help functions (@pxref{Documentation}) look for this property. -If the first character of @var{doc-string} is @samp{*}, it means that -this variable is considered a user option. This lets users set the -variable conveniently using the commands @code{set-variable} and -@code{edit-options}. However, it is better to use @code{defcustom} -instead of @code{defvar} for user option variables, so you can specify -customization information. @xref{Customization}. +If the variable is a user option that users would want to set +interactively, you should use @samp{*} as the first character of +@var{doc-string}. This lets users set the variable conveniently using +the @code{set-variable} command. Note that you should nearly always +use @code{defcustom} instead of @code{defvar} to define these +variables, so that users can use @kbd{M-x customize} and related +commands to set them. @xref{Customization}. Here are some examples. This form defines @code{foo} but does not initialize it: