Explain how disabled commands' doc strings are displayed.

This commit is contained in:
Richard M. Stallman 1996-12-12 05:36:22 +00:00
parent 31c8acc065
commit 75d97f473d

View file

@ -402,6 +402,12 @@ line. This looks nice in the source code, but looks bizarre when users
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