From: Richard M. Stallman <rms@gnu.org>
Date: Fri, 17 Jun 2005 13:43:31 +0000 (+0000)
Subject: (Documentation Basics): Explain the xref to Documentation Tips.
X-Git-Tag: emacs-pretest-22.0.90~8846
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b4bb5162bd5d644c3a3dc09a2c139202013c9a6f;p=emacs.git

(Documentation Basics): Explain the xref to Documentation Tips.
---

diff --git a/lispref/help.texi b/lispref/help.texi
index dfbc6c220f3..ec6dff13666 100644
--- a/lispref/help.texi
+++ b/lispref/help.texi
@@ -47,13 +47,15 @@ of a function or variable.  In a function definition, the documentation
 string follows the argument list.  In a variable definition, the
 documentation string follows the initial value of the variable.
 
-  When you write a documentation string, make the first line a complete
-sentence (or two complete sentences) since some commands, such as
-@code{apropos}, show only the first line of a multi-line documentation
-string.  Also, you should not indent the second line of a documentation
-string, if it has one, because that looks odd when you use @kbd{C-h f}
-(@code{describe-function}) or @kbd{C-h v} (@code{describe-variable}) to
-view the documentation string.  @xref{Documentation Tips}.
+  When you write a documentation string, make the first line a
+complete sentence (or two complete sentences) since some commands,
+such as @code{apropos}, show only the first line of a multi-line
+documentation string.  Also, you should not indent the second line of
+a documentation string, if it has one, because that looks odd when you
+use @kbd{C-h f} (@code{describe-function}) or @kbd{C-h v}
+(@code{describe-variable}) to view the documentation string.  There
+are many other conventions for doc strings; see @ref{Documentation
+Tips}.
 
   Documentation strings can contain several special substrings, which
 stand for key bindings to be looked up in the current keymaps when the