diff options
| author | Richard M. Stallman | 1996-12-12 05:36:22 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 1996-12-12 05:36:22 +0000 |
| commit | 75d97f473d3ea7b727686b32a30f91a52713b4f0 (patch) | |
| tree | 6b5f0615d027db11ae9fac7374aff929585fb066 | |
| parent | 31c8acc06530892e323641db66f8499bd5d126f7 (diff) | |
| download | emacs-75d97f473d3ea7b727686b32a30f91a52713b4f0.tar.gz emacs-75d97f473d3ea7b727686b32a30f91a52713b4f0.zip | |
Explain how disabled commands' doc strings are displayed.
| -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 | |||
| 403 | starting double-quote is not part of the string! | 403 | starting double-quote is not part of the string! |
| 404 | 404 | ||
| 405 | @item | 405 | @item |
| 406 | When the user tries to use a disabled command, Emacs displays just the | ||
| 407 | first paragraph of its documentation string---everything through the | ||
| 408 | first blank line. If you wish, you can choose which information to | ||
| 409 | include before the first blank line so as to make this display useful. | ||
| 410 | |||
| 411 | @item | ||
| 406 | A variable's documentation string should start with @samp{*} if the | 412 | A variable's documentation string should start with @samp{*} if the |
| 407 | variable is one that users would often want to set interactively. If | 413 | variable is one that users would often want to set interactively. If |
| 408 | the value is a long list, or a function, or if the variable would be set | 414 | the value is a long list, or a function, or if the variable would be set |