unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Stefan Kangas <stefankangas@gmail.com>
Cc: 41884@debbugs.gnu.org
Subject: bug#41884: 27.0.91; `C-h f whitespace-mode' doesn't say that it's a minor mode
Date: Sun, 2 Aug 2020 09:27:56 -0700 (PDT)	[thread overview]
Message-ID: <25af197b-05fb-4193-b617-a7d25fe43fd9@default> (raw)
In-Reply-To: <<833655ceg9.fsf@gnu.org>>

> > > The doc string for a minor mode should tell
> > > you it's a minor mode.
> >
> > Should all minor modes say this?
> 
> No, they don't.

That wasn't Stefan's question.  Should they?
I think they should.

Typically it takes only adding the words "minor
mode".  In the case of `whitespace-mode' it takes
only adding the word "minor":

 Toggle whitespace visualization (Whitespace minor mode).

I can't imagine why we _wouldn't_ want to tell
users this in the doc string.
____

[And, for the related problem that crops up wrt
minor-mode command doc strings - of not always
documenting well how to turn the mode on/off:
if someone decides to opt for a simple one-size
fits all fix, then that could be to just provide
a link to the doc about minor modes in each
minor-mode doc string.

IOW, once every minor-mode doc string says that
it's about a minor mode, a simple link to the doc
that tells you about minor modes would take care
of lacunae such as the doc string neglecting to
tell you clearly how to turn it on/off.

(It's still better to give that info directly in
the doc string, IMO, but such a link would make
sure to cover any such omission.)]





       reply	other threads:[~2020-08-02 16:27 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<2f814ee0-f472-43f6-878b-a9c9489d771e@default>
     [not found] ` <<CADwFkmm+bEojs03A76PoLPO08CQpTCfQZgErP2gYbXYumai1sw@mail.gmail.com>
     [not found]   ` <<833655ceg9.fsf@gnu.org>
2020-08-02 16:27     ` Drew Adams [this message]
2020-06-15 22:36 bug#41884: 27.0.91; `C-h f whitespace-mode' doesn't say that it's a minor mode Drew Adams
2020-08-02 10:47 ` Stefan Kangas
2020-08-02 14:25   ` Eli Zaretskii
2020-08-02 16:27   ` Drew Adams

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=25af197b-05fb-4193-b617-a7d25fe43fd9@default \
    --to=drew.adams@oracle.com \
    --cc=41884@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=stefankangas@gmail.com \
    /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 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).