From: Kelly Dean <kelly@prtime.org>
Date: Mon, 16 Feb 2015 04:22:16 +0000 (+0000)
Subject: emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
X-Git-Tag: emacs-25.0.90~2564^2~360
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cc273d1c033e669c642115550d2f132c7a9618b8;p=emacs.git

emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 9741baa64bd..b7ca890091b 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -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>
 
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index cd5720d144f..cc30042002b 100644
--- a/lisp/emacs-lisp/easy-mmode.el
+++ b/lisp/emacs-lisp/easy-mmode.el
@@ -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\".