# HG changeset patch
# User Luc Teirlinck <teirllm@auburn.edu>
# Date 1135048091 0
# Node ID a99220d00c0505873628b925581d569b46f380bb
# Parent  513f9a21b4609c1f5bb96ae666695a7b894e58ce
(Documentation Tips): Update for new conventions for using `*' in docstrings.

diff -r 513f9a21b460 -r a99220d00c05 lispref/tips.texi
--- a/lispref/tips.texi	Tue Dec 20 03:07:04 2005 +0000
+++ b/lispref/tips.texi	Tue Dec 20 03:08:11 2005 +0000
@@ -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
-@samp{*}.  @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{*}.
+@xref{Defining Variables}.
 
 @item
 The documentation string for a variable that is a yes-or-no flag should