[Emacs-diffs] emacs/doc/lispref variables.texi

[Chong Yidong]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Chong Yidong <cyd>      08/11/24 23:19:30

Modified files:
        doc/lispref    : variables.texi 

Log message:
        (Defining Variables): Note that `*' is not necessary if defcustom is
        used.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/emacs/doc/lispref/variables.texi?cvsroot=emacs&r1=1.9&r2=1.10

Patches:
Index: variables.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/lispref/variables.texi,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- variables.texi      19 Oct 2008 15:28:07 -0000      1.9
+++ variables.texi      24 Nov 2008 23:19:29 -0000      1.10
@@ -457,13 +457,13 @@
 stored in the symbol's @code{variable-documentation} property.  The
 Emacs help functions (@pxref{Documentation}) look for this property.
 
-If the variable is a user option that users would want to set
-interactively, you should use @samp{*} as the first character of
address@hidden  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}.
+If the documentation string begins with the character @samp{*}, Emacs
+allows users to set it interactively using the @code{set-variable}
+command.  However, you should nearly always use @code{defcustom}
+instead of @code{defvar} to define such variables, so that users can
+use @kbd{M-x customize} and related commands to set them.  In that
+case, it is not necessary to begin the documentation string with
address@hidden  @xref{Customization}.
 
 Here are some examples.  This form defines @code{foo} but does not
 initialize it: