From: Drew Adams <drew.adams@oracle.com>
To: 36500@debbugs.gnu.org
Subject: bug#36500: 26.2; Minor mode doc strings - say what the current mode-variable value is
Date: Thu, 4 Jul 2019 08:19:36 -0700 (PDT) [thread overview]
Message-ID: <4dc6d6ce-351c-426a-8371-3ce170c74f1a@default> (raw)
Apologies if this enhancement request has been proposed before.
It seems like it might have been, as it's a pretty obvious
possibility.
Suggestion:
Have the automatically provided part of a minor-mode doc string, from
`define-minor-mode' do the following (or at least some of it):
1. Mention the mode variable (typically the same name as the mode,
but in any case the name is known to `define-minor-mode').
(The doc string currently mentions the keymap, but not the var.)
2. Show the current value of the variable, just as we do for the keymap.
If undefined so far then say so, just as we do for the keymap.
3. Say whether the variable is global (an option, customizable), or
buffer-local.
4. Maybe mention that the variable is set/reset automatically when you
toggle the mode. If the var is global mention that you can set/reset
it manually using Customize.
5. Any particularities, e.g. from using `:variable' should be taken into
account, so the doc string is correct for all cases.
In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32)
of 2019-04-13
Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749
Windowing system distributor `Microsoft Corp.', version 10.0.17134
Configured using:
`configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install 'CFLAGS=-O2 -static -g3''
next reply other threads:[~2019-07-04 15:19 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-04 15:19 Drew Adams [this message]
2019-07-08 20:42 ` bug#36500: 26.2; Minor mode doc strings - say what the current mode-variable value is Lars Ingebrigtsen
2019-07-08 21:26 ` Drew Adams
2021-06-22 14:07 ` Lars Ingebrigtsen
2021-06-22 15:10 ` bug#36500: [External] : " 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=4dc6d6ce-351c-426a-8371-3ce170c74f1a@default \
--to=drew.adams@oracle.com \
--cc=36500@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 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).