489 |
stand on their own, the result looks bad. In particular, start the |
stand on their own, the result looks bad. In particular, start the |
490 |
first line with a capital letter and end with a period. |
first line with a capital letter and end with a period. |
491 |
|
|
492 |
The documentation string is not limited to one line; use as many lines |
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 |
``What does this function do?'' For a variable, the first line should |
494 |
variable. Please use complete sentences in the additional lines. |
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. |
499 |
|
|
500 |
@item |
@item |
501 |
For consistency, phrase the verb in the first sentence of a function's |
For consistency, phrase the verb in the first sentence of a function's |