diff options
| author | Richard M. Stallman <rms@gnu.org> | 1996-12-12 05:36:22 +0000 |
|---|---|---|
| committer | Richard M. Stallman <rms@gnu.org> | 1996-12-12 05:36:22 +0000 |
| commit | 75d97f473d3ea7b727686b32a30f91a52713b4f0 (patch) | |
| tree | 6b5f0615d027db11ae9fac7374aff929585fb066 /lispref | |
| parent | 31c8acc06530892e323641db66f8499bd5d126f7 (diff) | |
| download | emacs-75d97f473d3ea7b727686b32a30f91a52713b4f0.tar.gz | |
Explain how disabled commands' doc strings are displayed.
Diffstat (limited to 'lispref')
| -rw-r--r-- | lispref/tips.texi | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index bbc8ad7b708..7a10f212153 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi @@ -403,6 +403,12 @@ view the documentation. Remember that the indentation before the starting double-quote is not part of the string! @item +When the user tries to use a disabled command, Emacs displays just the +first paragraph of its documentation string---everything through the +first blank line. If you wish, you can choose which information to +include before the first blank line so as to make this display useful. + +@item A variable's documentation string should start with @samp{*} if the variable is one that users would often want to set interactively. If the value is a long list, or a function, or if the variable would be set |