]> git.eshelyaron.com Git - emacs.git/commitdiff
emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
authorKelly Dean <kelly@prtime.org>
Mon, 16 Feb 2015 04:22:16 +0000 (04:22 +0000)
committerArtur Malabarba <bruce.connor.am@gmail.com>
Wed, 18 Feb 2015 00:15:10 +0000 (22:15 -0200)
lisp/ChangeLog
lisp/emacs-lisp/easy-mmode.el

index 9741baa64bd4b4856d5fd8ae7d8c2da8364d2475..b7ca890091bf3c64ad1005555346b9d70646ba55 100644 (file)
@@ -2,6 +2,7 @@
 
        * emacs-lisp/easy-mmode.el (define-minor-mode): Process macro
        arguments correctly. (Bug#19685)
+       (define-minor-mode): Clarify docstring.
 
 2015-02-16  Kelly Dean  <kelly@prtime.org>
 
index cd5720d144f619c22c41d341ff51f52fd3d72297..cc30042002bb6dab992fe98d8faff6e2af482d7a 100644 (file)
@@ -114,9 +114,12 @@ Optional KEYMAP is the default keymap bound to the mode keymap.
 BODY contains code to execute each time the mode is enabled or disabled.
   It is executed after toggling the mode, and before running MODE-hook.
   Before the actual body code, you can write keyword arguments, i.e.
-  alternating keywords and values.  These following special keywords
-  are supported (other keywords are passed to `defcustom' if the minor
-  mode is global):
+  alternating keywords and values.  If you provide BODY, then you must
+  provide (even if just nil) INIT-VALUE, LIGHTER, and KEYMAP, or provide
+  at least one keyword argument, or both; otherwise, BODY would be
+  misinterpreted as the first omitted argument.  The following special
+  keywords are supported (other keywords are passed to `defcustom' if
+  the minor mode is global):
 
 :group GROUP   Custom group name to use in all generated `defcustom' forms.
                Defaults to MODE without the possible trailing \"-mode\".