GNU bug report logs - #30958
26.0.91; No documentation for key and value in the function passed to `map-keymap'

Previous Next

Full log

Message #28 received at 30958 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Kangas <stefan <at> marxist.se>, Hong Xu <hong <at> topbug.net>
Cc: Andreas Schwab <schwab <at> suse.de>,
 "30958 <at> debbugs.gnu.org" <30958 <at> debbugs.gnu.org>
Subject: RE: [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

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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.