emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

emacs-27 f539ee9: * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): D


From: Eli Zaretskii
Subject: emacs-27 f539ee9: * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak
Date: Sat, 10 Oct 2020 12:49:12 -0400 (EDT)

branch: emacs-27
commit f539ee9042f6eb30eecf928effab715396144744
Author: Stefan Monnier <monnier@iro.umontreal.ca>
Commit: Eli Zaretskii <eliz@gnu.org>

    * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc tweak
    
    Try and clarify the meaning of `init-value`.
    
    (cherry picked from commit 46c0f28c0e4e212687e90ec0ecb239d994105a19)
---
 lisp/emacs-lisp/easy-mmode.el | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index 59e2e2e..ad4f2d6 100644
--- a/lisp/emacs-lisp/easy-mmode.el
+++ b/lisp/emacs-lisp/easy-mmode.el
@@ -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),



reply via email to

[Prev in Thread] Current Thread [Next in Thread]