diff options
| author | Stefan Monnier <monnier@iro.umontreal.ca> | 2020-10-10 11:07:28 -0400 |
|---|---|---|
| committer | Stefan Monnier <monnier@iro.umontreal.ca> | 2020-10-10 11:07:28 -0400 |
| commit | 46c0f28c0e4e212687e90ec0ecb239d994105a19 (patch) | |
| tree | 8f79db492ba3c4f2c3a8d21080ff35f254f3cf80 | |
| parent | 0ed0dac0ca501a9f328c332a7993bf0624c3873c (diff) | |
| download | emacs-46c0f28c0e4e212687e90ec0ecb239d994105a19.tar.gz emacs-46c0f28c0e4e212687e90ec0ecb239d994105a19.tar.bz2 emacs-46c0f28c0e4e212687e90ec0ecb239d994105a19.zip | |
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak
Try and clarify the meaning of `init-value`.
| -rw-r--r-- | lisp/emacs-lisp/easy-mmode.el | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index fdc1233540e..8c1e5b227a6 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), |