all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Ihor Radchenko <yantar92@posteo.net>, 59600@debbugs.gnu.org
Subject: bug#59600: 28.1.90; Docstrings generated by `define-globalized-minor-mode' and `define-minor-mode' :global t are not same
Date: Sat, 26 Nov 2022 12:38:33 -0500	[thread overview]
Message-ID: <jwvsfi5k48q.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <83pmdat9lj.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 26 Nov 2022 10:15:36 +0200")

>> 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






  reply	other threads:[~2022-11-26 17:38 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
2022-11-26 17:46     ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=jwvsfi5k48q.fsf-monnier+emacs@gnu.org \
    --to=bug-gnu-emacs@gnu.org \
    --cc=59600@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=yantar92@posteo.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.