]> git.eshelyaron.com Git - emacs.git/commitdiff
Explain how disabled commands' doc strings are displayed.
authorRichard M. Stallman <rms@gnu.org>
Thu, 12 Dec 1996 05:36:22 +0000 (05:36 +0000)
committerRichard M. Stallman <rms@gnu.org>
Thu, 12 Dec 1996 05:36:22 +0000 (05:36 +0000)
lispref/tips.texi

index bbc8ad7b708d8506cb7f4fc71841f15d14c3759c..7a10f212153dba3b0d3be8089ddd3552b813cda2 100644 (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