[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#20462: 25.0.50; A minor mode's doc string should say it is [local/gl
bug#20462: 25.0.50; A minor mode's doc string should say it is [local/global] a minor mode
Sat, 30 Apr 2016 21:03:32 +0200
Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux)
Drew Adams <address@hidden> 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
> 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 in Thread]
||[Next in Thread]|
- bug#20462: 25.0.50; A minor mode's doc string should say it is [local/global] a minor mode,
Lars Ingebrigtsen <=