mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-11 00:30:17 -08:00
Code Issues Projects Releases Wiki Activity

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

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

(cherry picked from commit 46c0f28c0e)
This commit is contained in:
Stefan Monnier 2020-10-10 11:07:28 -04:00 • committed by Eli Zaretskii
parent c00606171f
commit f539ee9042
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lisp/emacs-lisp/easy-mmode.el
View 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),