summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorKelly Dean <kelly@prtime.org>2015-02-16 04:22:16 +0000
committerArtur Malabarba <bruce.connor.am@gmail.com>2015-02-17 22:15:10 -0200
commitcc273d1c033e669c642115550d2f132c7a9618b8 (patch)
tree5eaf21b5dd38c865415d296dbdc4debe4a5e3ebf /lisp/emacs-lisp
parent3194809d247efdc7ea65644ea7b298885e47a392 (diff)
downloademacs-cc273d1c033e669c642115550d2f132c7a9618b8.tar.gz
emacs-cc273d1c033e669c642115550d2f132c7a9618b8.tar.bz2
emacs-cc273d1c033e669c642115550d2f132c7a9618b8.zip
emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/easy-mmode.el9
1 files changed, 6 insertions, 3 deletions
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\".