* bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same
@ 2022-11-26 6:21 Ihor Radchenko
2022-11-26 8:15 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Ihor Radchenko @ 2022-11-26 6:21 UTC (permalink / raw)
To: 59600
Hi,
I noticed inconsistency between minor modes defined via
`define-globalized-minor-mode' and via `define-minor-mode' with :global
t keyword.
The former have the following in their docstring:
"Toggle %s in all buffers.\n"
"%s is enabled in all buffers where `%s' would do it."
However, no indication is given that globalized minor mode defined via
`define-minor-mode' :global t is global.
For example, `auto-save-visited-mode' is a global minor mode, but no
clear indication of this fact is given. It did cause confusion for some
users.
Expected: :global t clearly indicates that the mode is global.
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same
2022-11-26 6:21 bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same Ihor Radchenko
@ 2022-11-26 8:15 ` Eli Zaretskii
2022-11-26 17:38 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2022-11-26 8:15 UTC (permalink / raw)
To: Ihor Radchenko, Stefan Monnier; +Cc: 59600
> From: Ihor Radchenko <yantar92@posteo.net>
> Date: Sat, 26 Nov 2022 06:21:13 +0000
>
> I noticed inconsistency between minor modes defined via
> `define-globalized-minor-mode' and via `define-minor-mode' with :global
> t keyword.
>
> The former have the following in their docstring:
>
> "Toggle %s in all buffers.\n"
> "%s is enabled in all buffers where `%s' would do it."
>
> However, no indication is given that globalized minor mode defined via
> `define-minor-mode' :global t is global.
>
> For example, `auto-save-visited-mode' is a global minor mode, but no
> clear indication of this fact is given. It did cause confusion for some
> users.
>
> Expected: :global t clearly indicates that the mode is global.
Adding Stefan to the discussion.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same
2022-11-26 8:15 ` Eli Zaretskii
@ 2022-11-26 17:38 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-11-26 17:46 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2022-11-26 17:38 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: Ihor Radchenko, 59600
>> The former have the following in their docstring:
>>
>> "Toggle %s in all buffers.\n"
>> "%s is enabled in all buffers where `%s' would do it."
>>
>> However, no indication is given that globalized minor mode defined via
>> `define-minor-mode' :global t is global.
[ Nitpick: "define-minor-mode :global t" does not (usually) define
a "globalized mode" but rather it defines a "global mode". ]
>> For example, `auto-save-visited-mode' is a global minor mode, but no
>> clear indication of this fact is given. It did cause confusion for some
>> users.
>>
>> Expected: :global t clearly indicates that the mode is global.
>
> Adding Stefan to the discussion.
Not much to say, but I agree it makes sense for the docstring to state
the scope of the mode (global, buffer-local, younameit).
Stefan
^ permalink raw reply [flat|nested] 4+ messages in thread* bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same
2022-11-26 17:38 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2022-11-26 17:46 ` Eli Zaretskii
0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2022-11-26 17:46 UTC (permalink / raw)
To: Stefan Monnier; +Cc: yantar92, 59600
> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: Ihor Radchenko <yantar92@posteo.net>, 59600@debbugs.gnu.org
> Date: Sat, 26 Nov 2022 12:38:33 -0500
>
> [ Nitpick: "define-minor-mode :global t" does not (usually) define
> a "globalized mode" but rather it defines a "global mode". ]
>
> >> For example, `auto-save-visited-mode' is a global minor mode, but no
> >> clear indication of this fact is given. It did cause confusion for some
> >> users.
> >>
> >> Expected: :global t clearly indicates that the mode is global.
> >
> > Adding Stefan to the discussion.
>
> Not much to say, but I agree it makes sense for the docstring to state
> the scope of the mode (global, buffer-local, younameit).
Patches to the macro that defines the modes are welcome.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-11-26 17:46 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-11-26 6:21 bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same Ihor Radchenko
2022-11-26 8:15 ` Eli Zaretskii
2022-11-26 17:38 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-11-26 17:46 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).