Mercurial > emacs

diff lispref/help.texi @ 31130:e9c859a12e47

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a comment about the significance of an asterisk as the first character of a variable's doc string. Reported by Donald Knuth.
author Eli Zaretskii <eliz@gnu.org>
date Wed, 23 Aug 2000 12:05:12 +0000
parents d2e5f1b7d8e2
children 41ede3832703
line wrap: on
line diff
--- a/lispref/help.texi	Wed Aug 23 11:54:24 2000 +0000
+++ b/lispref/help.texi	Wed Aug 23 12:05:12 2000 +0000
@@ -241,6 +241,11 @@
 @end group
 @end smallexample
 
+The asterisk @samp{*} as the first character of a variable's doc string,
+as shown above for the @code{goal-column} variable, means that it is a
+user option; see the description of @code{defvar} in @ref{Defining
+Variables}.
+
 @defun Snarf-documentation filename
 This function is used only during Emacs initialization, just before
 the runnable Emacs is dumped.  It finds the file offsets of the