mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
Code Issues Releases Activity

(Documentation): Move xref to Emacs Manual here.

Browse Source 
(Documentation Basics): From here.
Also doc emacs-lisp-docstring-fill-column.
This commit is contained in:
Richard M. Stallman 2006-10-16 18:53:04 +00:00
parent 1e24a34b74
commit 652fcb8f37
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lispref/help.texi
View File

@ -22,6 +22,9 @@ of documentation strings is not sufficient as a manual because a good
manual is not organized in that fashion; it is organized in terms of manual is not organized in that fashion; it is organized in terms of
topics of discussion. topics of discussion.
For commands to access documentation strings, see @ref{Help, ,
Help, emacs, The GNU Emacs Manual}.
@menu @menu
* Documentation Basics:: Good style for doc strings. * Documentation Basics:: Good style for doc strings.
Where to put them. How Emacs stores them. Where to put them. How Emacs stores them.
@ -63,6 +66,10 @@ documentation is displayed. This allows documentation strings to refer
to the keys for related commands and be accurate even when a user to the keys for related commands and be accurate even when a user
rearranges the key bindings. (@xref{Keys in Documentation}.) rearranges the key bindings. (@xref{Keys in Documentation}.)
@vindex emacs-lisp-docstring-fill-column
Emacs Lisp mode fills documentation strings to the width
controlled by @code{emacs-lisp-docstring-fill-column}.
In Emacs Lisp, a documentation string is accessible through the In Emacs Lisp, a documentation string is accessible through the
function or variable that it describes: function or variable that it describes:
@ -100,9 +107,6 @@ documentation string. The functions @code{documentation} and
documentation string from the appropriate file; this is transparent to documentation string from the appropriate file; this is transparent to
the user. the user.
For information on the uses of documentation strings, see @ref{Help, ,
Help, emacs, The GNU Emacs Manual}.
@c Wordy to prevent overfull hbox. --rjc 15mar92 @c Wordy to prevent overfull hbox. --rjc 15mar92
The @file{emacs/lib-src} directory contains two utilities that you can The @file{emacs/lib-src} directory contains two utilities that you can
use to print nice-looking hardcopy for the file use to print nice-looking hardcopy for the file