diff options
| author | Richard M. Stallman | 2005-06-17 13:43:31 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-06-17 13:43:31 +0000 |
| commit | b4bb5162bd5d644c3a3dc09a2c139202013c9a6f (patch) | |
| tree | ca88080acc9f87a0b495910315a8239e9227ca73 | |
| parent | d5ecfb935c4f9192ef0419331770838a8abd35f2 (diff) | |
| download | emacs-b4bb5162bd5d644c3a3dc09a2c139202013c9a6f.tar.gz emacs-b4bb5162bd5d644c3a3dc09a2c139202013c9a6f.zip | |
(Documentation Basics): Explain the xref to Documentation Tips.
| -rw-r--r-- | lispref/help.texi | 16 |
1 files changed, 9 insertions, 7 deletions
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 | |||
| 47 | string follows the argument list. In a variable definition, the | 47 | string follows the argument list. In a variable definition, the |
| 48 | documentation string follows the initial value of the variable. | 48 | documentation string follows the initial value of the variable. |
| 49 | 49 | ||
| 50 | When you write a documentation string, make the first line a complete | 50 | When you write a documentation string, make the first line a |
| 51 | sentence (or two complete sentences) since some commands, such as | 51 | complete sentence (or two complete sentences) since some commands, |
| 52 | @code{apropos}, show only the first line of a multi-line documentation | 52 | such as @code{apropos}, show only the first line of a multi-line |
| 53 | string. Also, you should not indent the second line of a documentation | 53 | documentation string. Also, you should not indent the second line of |
| 54 | string, if it has one, because that looks odd when you use @kbd{C-h f} | 54 | a documentation string, if it has one, because that looks odd when you |
| 55 | (@code{describe-function}) or @kbd{C-h v} (@code{describe-variable}) to | 55 | use @kbd{C-h f} (@code{describe-function}) or @kbd{C-h v} |
| 56 | view the documentation string. @xref{Documentation Tips}. | 56 | (@code{describe-variable}) to view the documentation string. There |
| 57 | are many other conventions for doc strings; see @ref{Documentation | ||
| 58 | Tips}. | ||
| 57 | 59 | ||
| 58 | Documentation strings can contain several special substrings, which | 60 | Documentation strings can contain several special substrings, which |
| 59 | stand for key bindings to be looked up in the current keymaps when the | 61 | stand for key bindings to be looked up in the current keymaps when the |