unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: emacs-devel@gnu.org
Subject: \\{foo-mode-map}
Date: Fri, 29 Oct 2021 20:43:25 +0200	[thread overview]
Message-ID: <877ddvvfhu.fsf@gnus.org> (raw)

`C-h m' displays the doc string of the current major mode.  It does not
output the mode map -- unless the programmer has put \\{foo-mode-map}
into the doc string.  Many modes do not, which means that the user has
to rely on `C-h b' to try to find out what the available commands are.
Which isn't optimal.

I think it might be a good idea to change `C-h m' so that it always
outputs the major mode map.  That is, if the doc string already does so,
it shouldn't output it again, but if the doc string doesn't, then output
the major mode map after the doc string.

And then we could stop encouraging that these doc strings include
\\{foo-mode-map}.

Any opinions?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




             reply	other threads:[~2021-10-29 18:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-29 18:43 Lars Ingebrigtsen [this message]
2021-10-29 19:06 ` \\{foo-mode-map} Stefan Monnier
2021-10-29 19:18   ` \\{foo-mode-map} Lars Ingebrigtsen

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=877ddvvfhu.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=emacs-devel@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).