Commit f539ee90 authored by Stefan Monnier's avatar Stefan Monnier Committed by Eli Zaretskii

* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak

Try and clarify the meaning of `init-value`.

(cherry picked from commit 46c0f28c)
parent c0060617
Pipeline #7298 failed with stage
in 16 seconds
......@@ -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),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment