mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-11 16:08:13 +00:00
Code Issues Releases Activity

Minor cleanups.

Browse Source
This commit is contained in:
Richard M. Stallman 2002-01-26 22:43:53 +00:00
parent 8fc7780138
commit b090d7925a
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
lispref/tips.texi
View File

@ -482,6 +482,17 @@ by using a comment instead of a documentation string, but that is no
longer the case---documentation strings now take up very little space in longer the case---documentation strings now take up very little space in
a running Emacs. a running Emacs.
@item
Format the documentation string so that it fits in an Emacs window on an
80-column screen. It is a good idea for most lines to be no wider than
60 characters. The first line should not be wider than 67 characters
or it will look bad in the output of @code{apropos}.
You can fill the text if that looks good. However, rather than blindly
filling the entire documentation string, you can often make it much more
readable by choosing certain line breaks with care. Use blank lines
between topics if the documentation string is long.
@item @item
The first line of the documentation string should consist of one or two The first line of the documentation string should consist of one or two
complete sentences that stand on their own as a summary. @kbd{M-x complete sentences that stand on their own as a summary. @kbd{M-x
@ -503,7 +514,7 @@ documentation string as an imperative--for instance, use ``Return the
cons of A and B.'' in preference to ``Returns the cons of A and B@.'' cons of A and B.'' in preference to ``Returns the cons of A and B@.''
Usually it looks good to do likewise for the rest of the first Usually it looks good to do likewise for the rest of the first
paragraph. Subsequent paragraphs usually look better if each sentence paragraph. Subsequent paragraphs usually look better if each sentence
has a proper subject. is indicative and has a proper subject.
@item @item
Write documentation strings in the active voice, not the passive, and in Write documentation strings in the active voice, not the passive, and in
@ -527,17 +538,6 @@ In Dired, visit the file or directory named on this line.
@item @item
Do not start or end a documentation string with whitespace. Do not start or end a documentation string with whitespace.
@item
Format the documentation string so that it fits in an Emacs window on an
80-column screen. It is a good idea for most lines to be no wider than
60 characters. The first line should not be wider than 67 characters
or it will look bad in the output of @code{apropos}.
You can fill the text if that looks good. However, rather than blindly
filling the entire documentation string, you can often make it much more
readable by choosing certain line breaks with care. Use blank lines
between topics if the documentation string is long.
@item @item
@strong{Do not} indent subsequent lines of a documentation string so @strong{Do not} indent subsequent lines of a documentation string so