From: Drew Adams <drew.adams@oracle.com>
To: 33912@debbugs.gnu.org
Subject: bug#33912: 27.0.50; Mention in minor-mode doc strings that the mode is a minor mode
Date: Sat, 29 Dec 2018 08:13:54 -0800 (PST) [thread overview]
Message-ID: <91d52419-1370-4a8b-9df5-6f4fd1c70dbd@default> (raw)
Please consider mentioning explicitly in the doc string of all minor
modes (at least those defined using `define-minor-mode') that the mode
is a minor mode.
I thought there was already a bug, and agreement that it should be
fixed, saying that more of the full info that the doc string of
`define-minor-mode' provides should also be provided in the doc string
of each mode. But maybe that never happened or was agreed upon.
In any case, it can help a mode's doc to have it state that the mode is
a minor mode. Even more helpful would be a link to either (1) the doc
of `define-minor-mode' or (2) the manual.
Users are often confused about how to turn a minor mode on/off,
including in their init files (i.e., using Lisp). If a mode's doc
doesn't make clear whether it is a major or a minor mode then this lack
adds to confusion about how to enable/disable it, because the two kinds
of mode are handled very differently (and a major mode is disabled only
by enabled a different one, and major modes cannot be combined).
The doc string of a major usually (always?) does say that it is a major
mode. It is even more important that the doc of a minor say that the
mode is minor - minor modes can be disabled and combined.
In GNU Emacs 27.0.50 (build 3, x86_64-w64-mingw32)
of 2018-03-21
Repository revision: e70d0c9e66d7a8609450b2889869d16aeb0363b5
Windowing system distributor `Microsoft Corp.', version 10.0.16299
Configured using:
`configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install -C 'CFLAGS=-O2 -static -g3''
reply other threads:[~2018-12-29 16:13 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=91d52419-1370-4a8b-9df5-6f4fd1c70dbd@default \
--to=drew.adams@oracle.com \
--cc=33912@debbugs.gnu.org \
/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.