procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Kelly Dean 2015-02-16 04:22:16 +00:00 • committed by Artur Malabarba
parent 3194809d24
commit cc273d1c03
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lisp/emacs-lisp/easy-mmode.el
View 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\".