summaryrefslogtreecommitdiff
path: root/lisp/help.el
diff options
context:
space:
mode:
authorJohn Paul Wallington <jpw@pobox.com>2004-04-12 10:25:33 +0000
committerJohn Paul Wallington <jpw@pobox.com>2004-04-12 10:25:33 +0000
commitefde809a8389d882d2598ef845ed5ac901fe0061 (patch)
tree0da9b76106ca498b0935aabcbeabbbe82df6d336 /lisp/help.el
parent4ed1f829e272a5075937e40ed5a300c4f918570f (diff)
downloademacs-efde809a8389d882d2598ef845ed5ac901fe0061.tar.gz
(describe-mode): Doc fix.
Diffstat (limited to 'lisp/help.el')
-rw-r--r--lisp/help.el12
1 files changed, 7 insertions, 5 deletions
diff --git a/lisp/help.el b/lisp/help.el
index 82a43c6868b..b589de94474 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -564,11 +564,13 @@ the last key hit are used."
(defun describe-mode (&optional buffer)
"Display documentation of current major mode and minor modes.
-The major mode description comes first, followed by the minor modes,
-each on a separate page.
-For this to work correctly for a minor mode, the mode's indicator variable
-\(listed in `minor-mode-alist') must also be a function whose documentation
-describes the minor mode."
+A brief summary of the minor modes comes first, followed by the
+major mode description. This is followed by detailed
+descriptions of the minor modes, each on a separate page.
+
+For this to work correctly for a minor mode, the mode's indicator
+variable \(listed in `minor-mode-alist') must also be a function
+whose documentation describes the minor mode."
(interactive)
(help-setup-xref (list #'describe-mode (or buffer (current-buffer)))
(interactive-p))