Commit 75d97f47 authored by Richard M. Stallman's avatar Richard M. Stallman
Browse files

Explain how disabled commands' doc strings are displayed.

parent 31c8acc0
......@@ -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!
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.
A variable's documentation string should start with @samp{*} if the
variable is one that users would often want to set interactively. If
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment