47 |
string follows the argument list. In a variable definition, the |
string follows the argument list. In a variable definition, the |
48 |
documentation string follows the initial value of the variable. |
documentation string follows the initial value of the variable. |
49 |
|
|
50 |
When you write a documentation string, make the first line a complete |
When you write a documentation string, make the first line a |
51 |
sentence (or two complete sentences) since some commands, such as |
complete sentence (or two complete sentences) since some commands, |
52 |
@code{apropos}, show only the first line of a multi-line documentation |
such as @code{apropos}, show only the first line of a multi-line |
53 |
string. Also, you should not indent the second line of a documentation |
documentation string. Also, you should not indent the second line of |
54 |
string, if it has one, because that looks odd when you use @kbd{C-h f} |
a documentation string, if it has one, because that looks odd when you |
55 |
(@code{describe-function}) or @kbd{C-h v} (@code{describe-variable}) to |
use @kbd{C-h f} (@code{describe-function}) or @kbd{C-h v} |
56 |
view the documentation string. @xref{Documentation Tips}. |
(@code{describe-variable}) to view the documentation string. There |
57 |
|
are many other conventions for doc strings; see @ref{Documentation |
58 |
|
Tips}. |
59 |
|
|
60 |
Documentation strings can contain several special substrings, which |
Documentation strings can contain several special substrings, which |
61 |
stand for key bindings to be looked up in the current keymaps when the |
stand for key bindings to be looked up in the current keymaps when the |