From b3f11e94fad97144c4bd01c0d6e729d27bc7bfc7 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sun, 18 Jun 2023 08:50:54 +0300 Subject: Fix documentation of :predicate in 'define-globalized-minor-mode' * doc/lispref/modes.texi (Defining Minor Modes): * lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Document that :predicate creates a customizable user option. (Bug#64048) --- lisp/emacs-lisp/easy-mmode.el | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'lisp/emacs-lisp/easy-mmode.el') diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 22ea12f0960..98c211325ab 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -450,14 +450,17 @@ TURN-ON is a function that will be called with no args in every buffer and that should try to turn MODE on if applicable for that buffer. Each of KEY VALUE is a pair of CL-style keyword arguments. -The :predicate argument specifies in which major modes should the +The :predicate key specifies in which major modes should the globalized minor mode be switched on. The value should be t (meaning switch on the minor mode in all major modes), nil (meaning don't switch on in any major mode), a list of modes (meaning switch on only in those modes and their descendants), or a list (not MODES...), meaning switch on in any major mode except MODES. The value can also mix all of these forms, see the info node `Defining Minor Modes' for -details. +details. The :predicate key causes the macro to create a user option +named the same as MODE, but ending with \"-modes\" instead of \"-mode\". +That user option can then be used to customize in which modes this +globalized minor mode will be switched on. As the minor mode defined by this function is always global, any :global keyword is ignored. Other keywords have the same meaning as in `define-minor-mode', -- cgit v1.2.3