From: Drew Adams <drew.adams@oracle.com>
To: Andreas Schwab <schwab@suse.de>, Hong Xu <hong@topbug.net>
Cc: 30958@debbugs.gnu.org
Subject: bug#30958: 26.0.91; No documentation for key and value in the function passed to `map-keymap'
Date: Tue, 27 Mar 2018 07:27:31 -0700 (PDT) [thread overview]
Message-ID: <2e495171-34f8-436e-9fc5-334bd93fde00@default> (raw)
In-Reply-To: <mvm1sg5dfon.fsf@suse.de>
> > However, I searched the document, and could not find any useful
> > information regarding the value of the binding.
>
> It is whatever you've put there, see define-key. A keymap is really
> just a mapping from a key to an arbitrary value, though if the keymap is
> to be used as a local keymap each value should have one of the forms as
> listed in the doc for define-key.
Yes, I think that is the point: what a keymap is, and so
what its entries are that are being mapped over.
The key is to know or look up what a keymap is. Maybe
this needs to be pointed out better in the doc string?
Maybe the doc string should point users to the doc about
keymaps? Typically we don't do that - if a user sees a
term that is unclear we count on them looking it up.
But maybe it's not clear from the doc string that the
key here is to know what keymap is? I would think that
that would be obvious, given that it is a function that
maps over keymap entries. But maybe it's not.
I don't really have a suggestion for this, but maybe
Hong Xu does.
next prev parent reply other threads:[~2018-03-27 14:27 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-25 21:44 bug#30958: 26.0.91; No documentation for key and value in the function passed to `map-keymap' Hong Xu
2018-03-27 4:15 ` Drew Adams
2018-03-27 8:07 ` Hong Xu
2018-03-27 9:35 ` Andreas Schwab
2018-03-27 14:27 ` Drew Adams [this message]
2018-03-27 17:39 ` Hong Xu
2021-10-23 18:03 ` Stefan Kangas
2021-10-23 19:03 ` bug#30958: [External] : " Drew Adams
2021-10-24 6:26 ` Stefan Kangas
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=2e495171-34f8-436e-9fc5-334bd93fde00@default \
--to=drew.adams@oracle.com \
--cc=30958@debbugs.gnu.org \
--cc=hong@topbug.net \
--cc=schwab@suse.de \
/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).