changeset 54815:d13dc0c5f80d

(describe-mode): Doc fix.
author John Paul Wallington <jpw@pobox.com>
date Mon, 12 Apr 2004 10:25:04 +0000
parents e40dfbc0d5f2
children 5cf37cfc7515
files lisp/help.el
diffstat 1 files changed, 7 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/help.el	Mon Apr 12 10:03:08 2004 +0000
+++ b/lisp/help.el	Mon Apr 12 10:25:04 2004 +0000
@@ -564,11 +564,13 @@
 
 (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))