Mercurial > emacs
changeset 63540:f69f062368dd
(Documentation Basics): Explain the xref to Documentation Tips.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 17 Jun 2005 13:43:31 +0000 |
parents | 9ba37e4dc689 |
children | ddec16fed4a2 |
files | lispref/help.texi |
diffstat | 1 files changed, 9 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/help.texi Fri Jun 17 13:42:18 2005 +0000 +++ b/lispref/help.texi Fri Jun 17 13:43:31 2005 +0000 @@ -47,13 +47,15 @@ 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