diff options
| author | Richard M. Stallman | 2001-11-13 02:20:53 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2001-11-13 02:20:53 +0000 |
| commit | aa5dbf7b628a88e6016dd41947a7fe7180b6eec6 (patch) | |
| tree | d825f826811d45e9557f5b194cade8fb4a6a0383 | |
| parent | 9e7814d262782cde5924804e8f784a9a701eae48 (diff) | |
| download | emacs-aa5dbf7b628a88e6016dd41947a7fe7180b6eec6.tar.gz emacs-aa5dbf7b628a88e6016dd41947a7fe7180b6eec6.zip | |
Say what questions first line of doc string should answer.
| -rw-r--r-- | lispref/tips.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index 1ecd312f4b5..aafd1436c0b 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi | |||
| @@ -489,9 +489,13 @@ apropos} displays just the first line, and if that line's contents don't | |||
| 489 | stand on their own, the result looks bad. In particular, start the | 489 | stand on their own, the result looks bad. In particular, start the |
| 490 | first line with a capital letter and end with a period. | 490 | first line with a capital letter and end with a period. |
| 491 | 491 | ||
| 492 | The documentation string is not limited to one line; use as many lines | 492 | For a function, the first line should briefly answer the question, |
| 493 | as you need to explain the details of how to use the function or | 493 | ``What does this function do?'' For a variable, the first line should |
| 494 | variable. Please use complete sentences in the additional lines. | 494 | briefly answer the question, ``What does this value mean?'' |
| 495 | |||
| 496 | Don't limit the documentation string to one line; use as many lines as | ||
| 497 | you need to explain the details of how to use the function or | ||
| 498 | variable. Please use complete sentences for the rest of the text too. | ||
| 495 | 499 | ||
| 496 | @item | 500 | @item |
| 497 | For consistency, phrase the verb in the first sentence of a function's | 501 | For consistency, phrase the verb in the first sentence of a function's |