]> 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)
committerEli Zaretskii <eliz@gnu.org>
Sat, 10 Oct 2020 16:48:00 +0000 (19:48 +0300)
Try and clarify the meaning of `init-value`.

(cherry picked from commit 46c0f28c0e4e212687e90ec0ecb239d994105a19)

lisp/emacs-lisp/easy-mmode.el

index 59e2e2e08ff0979eccbe161d8d333c6c6cc1a816..ad4f2d6c9eb62941aa0d049d1fe0df65350a41f5 100644 (file)
@@ -134,6 +134,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),