diff options
| author | Richard M. Stallman | 2006-10-16 18:53:04 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2006-10-16 18:53:04 +0000 |
| commit | 652fcb8f372360d836ac869ef92afc423f48accf (patch) | |
| tree | 5d28a1922efc26ed3607dacaaec43e2648eea5b5 | |
| parent | 1e24a34b74b993ffa5ea46552cbe073b2cebcfa8 (diff) | |
| download | emacs-652fcb8f372360d836ac869ef92afc423f48accf.tar.gz emacs-652fcb8f372360d836ac869ef92afc423f48accf.zip | |
(Documentation): Move xref to Emacs Manual here.
(Documentation Basics): From here.
Also doc emacs-lisp-docstring-fill-column.
| -rw-r--r-- | lispref/help.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lispref/help.texi b/lispref/help.texi index 6173c746d1e..798167696ee 100644 --- a/lispref/help.texi +++ b/lispref/help.texi | |||
| @@ -22,6 +22,9 @@ of documentation strings is not sufficient as a manual because a good | |||
| 22 | manual is not organized in that fashion; it is organized in terms of | 22 | manual is not organized in that fashion; it is organized in terms of |
| 23 | topics of discussion. | 23 | topics of discussion. |
| 24 | 24 | ||
| 25 | For commands to access documentation strings, see @ref{Help, , | ||
| 26 | Help, emacs, The GNU Emacs Manual}. | ||
| 27 | |||
| 25 | @menu | 28 | @menu |
| 26 | * Documentation Basics:: Good style for doc strings. | 29 | * Documentation Basics:: Good style for doc strings. |
| 27 | Where to put them. How Emacs stores them. | 30 | Where to put them. How Emacs stores them. |
| @@ -63,6 +66,10 @@ documentation is displayed. This allows documentation strings to refer | |||
| 63 | to the keys for related commands and be accurate even when a user | 66 | to the keys for related commands and be accurate even when a user |
| 64 | rearranges the key bindings. (@xref{Keys in Documentation}.) | 67 | rearranges the key bindings. (@xref{Keys in Documentation}.) |
| 65 | 68 | ||
| 69 | @vindex emacs-lisp-docstring-fill-column | ||
| 70 | Emacs Lisp mode fills documentation strings to the width | ||
| 71 | controlled by @code{emacs-lisp-docstring-fill-column}. | ||
| 72 | |||
| 66 | In Emacs Lisp, a documentation string is accessible through the | 73 | In Emacs Lisp, a documentation string is accessible through the |
| 67 | function or variable that it describes: | 74 | function or variable that it describes: |
| 68 | 75 | ||
| @@ -100,9 +107,6 @@ documentation string. The functions @code{documentation} and | |||
| 100 | documentation string from the appropriate file; this is transparent to | 107 | documentation string from the appropriate file; this is transparent to |
| 101 | the user. | 108 | the user. |
| 102 | 109 | ||
| 103 | For information on the uses of documentation strings, see @ref{Help, , | ||
| 104 | Help, emacs, The GNU Emacs Manual}. | ||
| 105 | |||
| 106 | @c Wordy to prevent overfull hbox. --rjc 15mar92 | 110 | @c Wordy to prevent overfull hbox. --rjc 15mar92 |
| 107 | The @file{emacs/lib-src} directory contains two utilities that you can | 111 | The @file{emacs/lib-src} directory contains two utilities that you can |
| 108 | use to print nice-looking hardcopy for the file | 112 | use to print nice-looking hardcopy for the file |