From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 20462@debbugs.gnu.org
Subject: bug#20462: 25.0.50; A minor mode's doc string should say it is [local/global] a minor mode
Date: Sat, 30 Apr 2016 21:03:32 +0200 [thread overview]
Message-ID: <87shy2dim3.fsf@gnus.org> (raw)
In-Reply-To: <38bd87fc-e9d5-43c1-9687-e66faf993c7e@default> (Drew Adams's message of "Wed, 29 Apr 2015 10:29:46 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> A minor mode created conventionally, i.e., using `define-minor-mode' or
> `define-globalized-minor-mode', should automatically have its doc string
> say explicitly that it is a minor mode and whether it is local or
> global.
>
> That helps users know what to expect, because all such minor modes have
> some things in common, which are well documented.
Yeah, I kinda think that `define-minor-mode' should include the toggle
verbiage by default at the start of all doc strings, even if there is a
doc string given. That would mean going through all the usages in the
tree and remove the leading incantations, but that's no big deal.
We could have a keyword :no-introduction t for the few modes that really
don't want the standard verbiage at the start.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
prev parent reply other threads:[~2016-04-30 19:03 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-04-29 17:29 bug#20462: 25.0.50; A minor mode's doc string should say it is [local/global] a minor mode Drew Adams
2015-04-30 7:12 ` Glenn Morris
2015-04-30 13:47 ` Drew Adams
2015-04-30 13:55 ` Drew Adams
2015-04-30 15:36 ` Artur Malabarba
2017-01-02 21:59 ` Drew Adams
2016-04-30 19:03 ` Lars Ingebrigtsen [this message]
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=87shy2dim3.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=20462@debbugs.gnu.org \
--cc=drew.adams@oracle.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).