From: Drew Adams <drew.adams@oracle.com>
To: Stefan Kangas <stefan@marxist.se>, Hong Xu <hong@topbug.net>
Cc: Andreas Schwab <schwab@suse.de>,
"30958@debbugs.gnu.org" <30958@debbugs.gnu.org>
Subject: bug#30958: [External] : Re: bug#30958: 26.0.91; No documentation for key and value in the function passed to `map-keymap'
Date: Sat, 23 Oct 2021 19:03:52 +0000 [thread overview]
Message-ID: <SJ0PR10MB5488537306344A58F300FBB3F3819@SJ0PR10MB5488.namprd10.prod.outlook.com> (raw)
In-Reply-To: <CADwFkmmimrTk8=GsgmCo0+8gFYUSovUhOsHg9PpWdXWWGwV8Jg@mail.gmail.com>
I agree with Stefan that the (1) doc is clear as
far as it goes, (2) the set of possible key-binding
representations is large and complex, and (3) to
understand this stuff you really need to carefully
study the carefully specified doc in the Elisp
manual for this.
(There are some other complex areas like this. One
is font-lock-keywords forms.)
My suggestion would be to help users by providing
a middle ground between (1) a correct but sparse
and little-explanatory doc string and (2) "pulling
in the entire reference manual worth of stuff to
explain all possible types of values":
Just add a link to the relevant section in the
manual. That way, instead of closing the door on
an interested reader of the doc string, you open
the door to a full understanding. An uninterested
reader might not follow the link - no harm, no foul.
next prev parent reply other threads:[~2021-10-23 19:03 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
2018-03-27 17:39 ` Hong Xu
2021-10-23 18:03 ` Stefan Kangas
2021-10-23 19:03 ` Drew Adams [this message]
2021-10-24 6:26 ` bug#30958: [External] : " 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=SJ0PR10MB5488537306344A58F300FBB3F3819@SJ0PR10MB5488.namprd10.prod.outlook.com \
--to=drew.adams@oracle.com \
--cc=30958@debbugs.gnu.org \
--cc=hong@topbug.net \
--cc=schwab@suse.de \
--cc=stefan@marxist.se \
/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).