]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak
authorStefan Monnier <monnier@iro.umontreal.ca>
Sat, 10 Oct 2020 15:07:28 +0000 (11:07 -0400)
committerStefan Monnier <monnier@iro.umontreal.ca>
Sat, 10 Oct 2020 15:07:28 +0000 (11:07 -0400)
Try and clarify the meaning of `init-value`.

lisp/emacs-lisp/easy-mmode.el

index fdc1233540e95add52715fc106a0f44ae632548d..8c1e5b227a6a91c614ee32b573b29c3b9e1f0c0b 100644 (file)
@@ -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),