[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master cc273d1 6/8: emacs-lisp/easy-mmode.el (define-minor
From: |
Artur Malabarba |
Subject: |
[Emacs-diffs] master cc273d1 6/8: emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs |
Date: |
Tue, 17 Feb 2015 23:17:57 +0000 |
branch: master
commit cc273d1c033e669c642115550d2f132c7a9618b8
Author: Kelly Dean <address@hidden>
Commit: Artur Malabarba <address@hidden>
emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs
---
lisp/ChangeLog | 1 +
lisp/emacs-lisp/easy-mmode.el | 9 ++++++---
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 9741baa..b7ca890 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 <address@hidden>
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index cd5720d..cc30042 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\".
- [Emacs-diffs] master updated (16d91bc -> 8338e44), Artur Malabarba, 2015/02/17
- [Emacs-diffs] master 77052f4 2/8: * help-mode.el: Prevent duplicated display of Info buffer. (Bug#13190), Artur Malabarba, 2015/02/17
- [Emacs-diffs] master cec04fb 1/8: * src/keyboard.c (timer_check_2): Fix incorrect comment, Artur Malabarba, 2015/02/17
- [Emacs-diffs] master 1e00ee2 3/8: desktop.el: Conditionally re-enable desktop autosave, Artur Malabarba, 2015/02/17
- [Emacs-diffs] master 1f2c4f8 4/8: emacs-lisp/package-x.el: Create valid tar files, Artur Malabarba, 2015/02/17
- [Emacs-diffs] master 3194809 5/8: emacs-lisp/easy-mmode.el: Process macro arguments correctly, Artur Malabarba, 2015/02/17
- [Emacs-diffs] master 0409684 7/8: emacs-lisp/easy-mmode.el: Clarify mode switch messages, Artur Malabarba, 2015/02/17
- [Emacs-diffs] master cc273d1 6/8: emacs-lisp/easy-mmode.el (define-minor-mode): Clarify docs,
Artur Malabarba <=
- [Emacs-diffs] master 8338e44 8/8: lisp/files.el (insert-file-contents-literally): Fix typo, Artur Malabarba, 2015/02/17