Mercurial > emacs
changeset 40970:fb31125d0d7b
Say what questions first line of doc string should answer.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Tue, 13 Nov 2001 02:20:53 +0000 |
| parents | 57ff4380e1fe |
| children | fa679d186a7d |
| files | lispref/tips.texi |
| diffstat | 1 files changed, 7 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/tips.texi Tue Nov 13 02:20:08 2001 +0000 +++ b/lispref/tips.texi Tue Nov 13 02:20:53 2001 +0000 @@ -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