diff options
| author | Kelly Dean | 2015-02-16 04:22:16 +0000 |
|---|---|---|
| committer | Artur Malabarba | 2015-02-17 22:15:10 -0200 |
| commit | cc273d1c033e669c642115550d2f132c7a9618b8 (patch) | |
| tree | 5eaf21b5dd38c865415d296dbdc4debe4a5e3ebf | |
| parent | 3194809d247efdc7ea65644ea7b298885e47a392 (diff) | |
| download | emacs-cc273d1c033e669c642115550d2f132c7a9618b8.tar.gz emacs-cc273d1c033e669c642115550d2f132c7a9618b8.zip | |
emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
| -rw-r--r-- | lisp/ChangeLog | 1 | ||||
| -rw-r--r-- | lisp/emacs-lisp/easy-mmode.el | 9 |
2 files changed, 7 insertions, 3 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 9741baa64bd..b7ca890091b 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -2,6 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | * emacs-lisp/easy-mmode.el (define-minor-mode): Process macro | 3 | * emacs-lisp/easy-mmode.el (define-minor-mode): Process macro |
| 4 | arguments correctly. (Bug#19685) | 4 | arguments correctly. (Bug#19685) |
| 5 | (define-minor-mode): Clarify docstring. | ||
| 5 | 6 | ||
| 6 | 2015-02-16 Kelly Dean <kelly@prtime.org> | 7 | 2015-02-16 Kelly Dean <kelly@prtime.org> |
| 7 | 8 | ||
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. | |||
| 114 | BODY contains code to execute each time the mode is enabled or disabled. | 114 | BODY contains code to execute each time the mode is enabled or disabled. |
| 115 | It is executed after toggling the mode, and before running MODE-hook. | 115 | It is executed after toggling the mode, and before running MODE-hook. |
| 116 | Before the actual body code, you can write keyword arguments, i.e. | 116 | Before the actual body code, you can write keyword arguments, i.e. |
| 117 | alternating keywords and values. These following special keywords | 117 | alternating keywords and values. If you provide BODY, then you must |
| 118 | are supported (other keywords are passed to `defcustom' if the minor | 118 | provide (even if just nil) INIT-VALUE, LIGHTER, and KEYMAP, or provide |
| 119 | mode is global): | 119 | at least one keyword argument, or both; otherwise, BODY would be |
| 120 | misinterpreted as the first omitted argument. The following special | ||
| 121 | keywords are supported (other keywords are passed to `defcustom' if | ||
| 122 | the minor mode is global): | ||
| 120 | 123 | ||
| 121 | :group GROUP Custom group name to use in all generated `defcustom' forms. | 124 | :group GROUP Custom group name to use in all generated `defcustom' forms. |
| 122 | Defaults to MODE without the possible trailing \"-mode\". | 125 | Defaults to MODE without the possible trailing \"-mode\". |