From: Eli Zaretskii <eliz@gnu.org>
To: Hong Xu <hong@topbug.net>
Cc: 75366-done@debbugs.gnu.org
Subject: bug#75366: [PATCH] Improve the doc of key-valid-p
Date: Sun, 05 Jan 2025 08:35:11 +0200 [thread overview]
Message-ID: <86ttadahuo.fsf@gnu.org> (raw)
In-Reply-To: <87y0zqtfus.fsf@topbug.net> (message from Hong Xu on Sat, 04 Jan 2025 13:43:23 -0800)
> From: Hong Xu <hong@topbug.net>
> Cc: 75366@debbugs.gnu.org
> Date: Sat, 04 Jan 2025 13:43:23 -0800
>
> On 2025-01-04 Sat 12:49 GMT-08, Eli Zaretskii <eliz@gnu.org> wrote:
>
> > What is wrong with the current text that you think it needs these
> > changes?
>
> The current text reads a bit confusing to me.
>
> The function, based on its name and the current text, gives me an
> impression that this is only about key strokes as those on a keyboard.
> However, it's actually more than key strokes as those on a keyboard.
> (I've added a mouse example in the updated patch to further clarify
> this.)
>
> For example, the "Modifying Menus" node (correctly) cites this function
> in the context of binding a menu item. The docstring of this function
> and the citing text together can confuse a unfamiliar reader quite a
> bit.
>
> Perhaps the ultimate confusion point is the name of the function and the
> definition of key sequences and key strokes in the docstring, but these
> may be harder to change.
Thanks, installed on the emacs-30 branch, and closing the bug.
prev parent reply other threads:[~2025-01-05 6:35 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-04 20:37 bug#75366: [PATCH] Improve the doc of key-valid-p Hong Xu
2025-01-04 20:44 ` Hong Xu
2025-01-04 20:49 ` Eli Zaretskii
2025-01-04 21:43 ` Hong Xu
2025-01-05 6:35 ` Eli Zaretskii [this message]
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=86ttadahuo.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=75366-done@debbugs.gnu.org \
--cc=hong@topbug.net \
/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).