aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2001-09-06 19:43:44 +0000
committerRichard M. Stallman2001-09-06 19:43:44 +0000
commit2a2048f2e24a87da51be10a06ccdff425eae4c51 (patch)
tree562fe4132e6b8921c9a23cb5dac4eb364b9f0bc7
parent883c005a1b5e2766c053271dd6f0ffea54340920 (diff)
downloademacs-2a2048f2e24a87da51be10a06ccdff425eae4c51.tar.gz
emacs-2a2048f2e24a87da51be10a06ccdff425eae4c51.zip
Correct the statement of when to use * in variable doc strings.
-rw-r--r--lispref/variables.texi13
1 files changed, 7 insertions, 6 deletions
diff --git a/lispref/variables.texi b/lispref/variables.texi
index 8ab6739bdb7..5b981013708 100644
--- a/lispref/variables.texi
+++ b/lispref/variables.texi
@@ -452,12 +452,13 @@ the main benefits of defining the variable.) The documentation is
452stored in the symbol's @code{variable-documentation} property. The 452stored in the symbol's @code{variable-documentation} property. The
453Emacs help functions (@pxref{Documentation}) look for this property. 453Emacs help functions (@pxref{Documentation}) look for this property.
454 454
455If the first character of @var{doc-string} is @samp{*}, it means that 455If the variable is a user option that users would want to set
456this variable is considered a user option. This lets users set the 456interactively, you should use @samp{*} as the first character of
457variable conveniently using the commands @code{set-variable} and 457@var{doc-string}. This lets users set the variable conveniently using
458@code{edit-options}. However, it is better to use @code{defcustom} 458the @code{set-variable} command. Note that you should nearly always
459instead of @code{defvar} for user option variables, so you can specify 459use @code{defcustom} instead of @code{defvar} to define these
460customization information. @xref{Customization}. 460variables, so that users can use @kbd{M-x customize} and related
461commands to set them. @xref{Customization}.
461 462
462Here are some examples. This form defines @code{foo} but does not 463Here are some examples. This form defines @code{foo} but does not
463initialize it: 464initialize it: