[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 46c0f28: * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc
From: |
Stefan Monnier |
Subject: |
master 46c0f28: * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak |
Date: |
Sat, 10 Oct 2020 11:07:33 -0400 (EDT) |
branch: master
commit 46c0f28c0e4e212687e90ec0ecb239d994105a19
Author: Stefan Monnier <monnier@iro.umontreal.ca>
Commit: Stefan Monnier <monnier@iro.umontreal.ca>
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak
Try and clarify the meaning of `init-value`.
---
lisp/emacs-lisp/easy-mmode.el | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index fdc1233..8c1e5b2 100644
--- a/lisp/emacs-lisp/easy-mmode.el
+++ b/lisp/emacs-lisp/easy-mmode.el
@@ -137,6 +137,10 @@ appear in DOC, a paragraph is added to DOC explaining
usage of the mode argument.
Optional INIT-VALUE is the initial value of the mode's variable.
+ Note that the minor mode function won't be called by setting
+ this option, so the value *reflects* the minor mode's natural
+ initial state, rather than *setting* it.
+ In the vast majority of cases it should be nil.
Optional LIGHTER is displayed in the mode line when the mode is on.
Optional KEYMAP is the default keymap bound to the mode keymap.
If non-nil, it should be a variable name (whose value is a keymap),
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 46c0f28: * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak,
Stefan Monnier <=