* bug#29497: 26.0.90; doc strings of minor modes
@ 2017-11-29 4:47 Drew Adams
0 siblings, 0 replies; 2+ messages in thread
From: Drew Adams @ 2017-11-29 4:47 UTC (permalink / raw)
To: 29497
Other bug reports have requested that minor-mode doc strings follow more
closely what `define-minor-mode' has to say about minor modes.
This request adds to that. How about trying to have `C-h f' somehow
detect minor-mode commands (at least those created by
`define-minor-mode', and change the first line of help output.
Instead of something like this:
abbrev-mode is an interactive compiled Lisp function in `abbrev.el'.
It might say something like this:
abbrev-mode is a compiled minor-mode command in `abbrev.el'.
Or perhaps the fact that the command is a minor-mode command could just
be added systematically to the doc string itself. Indicating to users
in some way that the command is a minor-mode command would be helpful.
In GNU Emacs 26.0.90 (build 3, x86_64-w64-mingw32)
of 2017-10-13 built on LAPHROAIG
Repository revision: 906224eba147bdfc0514090064e8e8f53160f1d4
Windowing system distributor 'Microsoft Corp.', version 6.1.7601
Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Configured using:
'configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install 'CFLAGS=-O2 -static -g3''
Configured features:
XPM JPEG TIFF GIF PNG RSVG SOUND NOTIFY ACL GNUTLS LIBXML2 ZLIB
TOOLKIT_SCROLL_BARS
^ permalink raw reply [flat|nested] 2+ messages in thread
* bug#29497: 26.0.90; doc strings of minor modes
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
@ 2021-06-30 13:31 ` Lars Ingebrigtsen
0 siblings, 0 replies; 2+ messages in thread
From: Lars Ingebrigtsen @ 2021-06-30 13:31 UTC (permalink / raw)
To: Drew Adams; +Cc: 41884, 29497
Drew Adams <drew.adams@oracle.com> writes:
> Subject line says it all. The doc string for a minor mode should tell
> you it's a minor mode.
I've now added this to the Emacs 28 minor mode doc strings.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-06-30 13:31 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-11-29 4:47 bug#29497: 26.0.90; doc strings of minor modes Drew Adams
-- strict thread matches above, loose matches on Subject: below --
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
2021-06-30 13:31 ` bug#29497: 26.0.90; doc strings of minor modes Lars Ingebrigtsen
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).