[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/lispref/tips.texi
From: |
Richard M. Stallman |
Subject: |
[Emacs-diffs] Changes to emacs/lispref/tips.texi |
Date: |
Mon, 12 Nov 2001 21:20:53 -0500 |
Index: emacs/lispref/tips.texi
diff -u emacs/lispref/tips.texi:1.39 emacs/lispref/tips.texi:1.40
--- emacs/lispref/tips.texi:1.39 Wed Oct 31 09:44:17 2001
+++ emacs/lispref/tips.texi Mon Nov 12 21:20:53 2001
@@ -489,9 +489,13 @@
stand on their own, the result looks bad. In particular, start the
first line with a capital letter and end with a period.
-The documentation string is not limited to one line; use as many lines
-as you need to explain the details of how to use the function or
-variable. Please use complete sentences in the additional lines.
+For a function, the first line should briefly answer the question,
+``What does this function do?'' For a variable, the first line should
+briefly answer the question, ``What does this value mean?''
+
+Don't limit the documentation string to one line; use as many lines as
+you need to explain the details of how to use the function or
+variable. Please use complete sentences for the rest of the text too.
@item
For consistency, phrase the verb in the first sentence of a function's
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] Changes to emacs/lispref/tips.texi,
Richard M. Stallman <=