unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Stefan Kangas <stefankangas@gmail.com>, 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:41 -0700 (PDT)	[thread overview]
Message-ID: <81a68df2-ac5b-47f2-bbfb-1ea37c67426f@default> (raw)
In-Reply-To: <CADwFkmm+bEojs03A76PoLPO08CQpTCfQZgErP2gYbXYumai1sw@mail.gmail.com>

> > The doc string for a minor mode should tell
> > you it's a minor mode.
> 
> Should all minor modes say this?  Because there are more examples of
> modes that don't, such as:
> - display-line-numbers-mode
> - whitespace-newline-mode
> 
> This is just from taking a quick look.

Yes, IMO they should.  Otherwise, how will
users know?  (OK, there are ways...)

Knowing a command is a minor mode is very
important to understanding its use.  It's
could even be argued that it's the most
important thing to know about it.
____

More generally, I think a failing of some
minor-mode doc strings is that they don't
tell you the basics of what the doc string
of `define-minor-mode' tells you, e.g. how
to turn the mode on/off, both interactively
and from Lisp.

This related problem has been taken care of
here and there over the years, bit by bit,
from bug reports etc.  But I think the
problem is still present here and there.

Anyway, this bug report is only about
`whitespace-mode'.  If someone wants to
fix its problem along with that of other
minor-mode commands, please do.





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

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
2021-06-30 13:31 ` bug#29497: 26.0.90; doc strings of minor modes Lars Ingebrigtsen
     [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     ` bug#41884: 27.0.91; `C-h f whitespace-mode' doesn't say that it's a minor mode 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=81a68df2-ac5b-47f2-bbfb-1ea37c67426f@default \
    --to=drew.adams@oracle.com \
    --cc=41884@debbugs.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).