aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2002-01-26 22:43:53 +0000
committerRichard M. Stallman2002-01-26 22:43:53 +0000
commitb090d7925af7db73444eef735ddf18c907635e75 (patch)
tree3e2abffe026fd34cc53fca5aa0153aafb7f76c47
parent8fc7780138c29ea25de148a8592d827d5d4657fd (diff)
downloademacs-b090d7925af7db73444eef735ddf18c907635e75.tar.gz
emacs-b090d7925af7db73444eef735ddf18c907635e75.zip
Minor cleanups.
-rw-r--r--lispref/tips.texi24
1 files changed, 12 insertions, 12 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi
index aafd1436c0b..322686d86a9 100644
--- a/lispref/tips.texi
+++ b/lispref/tips.texi
@@ -483,6 +483,17 @@ longer the case---documentation strings now take up very little space in
483a running Emacs. 483a running Emacs.
484 484
485@item 485@item
486Format the documentation string so that it fits in an Emacs window on an
48780-column screen. It is a good idea for most lines to be no wider than
48860 characters. The first line should not be wider than 67 characters
489or it will look bad in the output of @code{apropos}.
490
491You can fill the text if that looks good. However, rather than blindly
492filling the entire documentation string, you can often make it much more
493readable by choosing certain line breaks with care. Use blank lines
494between topics if the documentation string is long.
495
496@item
486The first line of the documentation string should consist of one or two 497The first line of the documentation string should consist of one or two
487complete sentences that stand on their own as a summary. @kbd{M-x 498complete sentences that stand on their own as a summary. @kbd{M-x
488apropos} displays just the first line, and if that line's contents don't 499apropos} displays just the first line, and if that line's contents don't
@@ -503,7 +514,7 @@ documentation string as an imperative--for instance, use ``Return the
503cons of A and B.'' in preference to ``Returns the cons of A and B@.'' 514cons of A and B.'' in preference to ``Returns the cons of A and B@.''
504Usually it looks good to do likewise for the rest of the first 515Usually it looks good to do likewise for the rest of the first
505paragraph. Subsequent paragraphs usually look better if each sentence 516paragraph. Subsequent paragraphs usually look better if each sentence
506has a proper subject. 517is indicative and has a proper subject.
507 518
508@item 519@item
509Write documentation strings in the active voice, not the passive, and in 520Write 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.
527 538
528@item 539@item
529Do not start or end a documentation string with whitespace. 540Do not start or end a documentation string with whitespace.
530
531@item
532Format the documentation string so that it fits in an Emacs window on an
53380-column screen. It is a good idea for most lines to be no wider than
53460 characters. The first line should not be wider than 67 characters
535or it will look bad in the output of @code{apropos}.
536
537You can fill the text if that looks good. However, rather than blindly
538filling the entire documentation string, you can often make it much more
539readable by choosing certain line breaks with care. Use blank lines
540between topics if the documentation string is long.
541 541
542@item 542@item
543@strong{Do not} indent subsequent lines of a documentation string so 543@strong{Do not} indent subsequent lines of a documentation string so