[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/lispref/tips.texi
From: |
Luc Teirlinck |
Subject: |
[Emacs-diffs] Changes to emacs/lispref/tips.texi |
Date: |
Tue, 20 Dec 2005 03:08:11 +0000 |
Index: emacs/lispref/tips.texi
diff -u emacs/lispref/tips.texi:1.73 emacs/lispref/tips.texi:1.74
--- emacs/lispref/tips.texi:1.73 Fri Oct 28 21:53:30 2005
+++ emacs/lispref/tips.texi Tue Dec 20 03:08:11 2005
@@ -640,11 +640,10 @@
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
address@hidden @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{*}.
address@hidden Variables}.
@item
The documentation string for a variable that is a yes-or-no flag should
- [Emacs-diffs] Changes to emacs/lispref/tips.texi,
Luc Teirlinck <=