From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#75366: [PATCH] Improve the doc of key-valid-p Date: Sun, 05 Jan 2025 08:35:11 +0200 Message-ID: <86ttadahuo.fsf@gnu.org> References: <20250104203955.139589-1-hong@topbug.net> <864j2eb8ym.fsf@gnu.org> <87y0zqtfus.fsf@topbug.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="40426"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 75366-done@debbugs.gnu.org To: Hong Xu Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jan 05 07:36:30 2025 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tUKFR-000ANY-Kt for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Jan 2025 07:36:29 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tUKF6-0002u0-ML; Sun, 05 Jan 2025 01:36:08 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tUKF1-0002tA-1x for bug-gnu-emacs@gnu.org; Sun, 05 Jan 2025 01:36:04 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tUKF0-0003fH-Lu for bug-gnu-emacs@gnu.org; Sun, 05 Jan 2025 01:36:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=References:In-Reply-To:From:Date:To:Subject; bh=6c4rb+k9kYBp4YVcE0++vSjBcuDaywVXeBfeal9EKdw=; b=Co4OVuId18WmojB4mDFhs7+T97xqn94gE2A/Gt82Abyp4L+KOoCXfoXz7Co0UenQKfa5q8da+BwO6k9I6QyOpm5krVEaW3rT1kHlmeguJq0gx4BMhuOcy/Ljlo3EhuDs+DRqZLeQo0/pwybeGaRtkw7bVOuxf+Tx14cytkVvImwIcfR88fL8gI/+HV8S2LHrtEYhjoGaQIVZM0aTanbpf5797XstIGHxSjcouiX5RbCD9hDWmrfwgK/dbK1bXgVz3C1V9SgM5rhmYkPE4hedOUptS+xmawG3sfjVt9w0N2IxDqJ/lcsd1xV0tY5mFXs5U6woE5h0k5aW6RgN841OkA==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tUKF0-0006a2-G6 for bug-gnu-emacs@gnu.org; Sun, 05 Jan 2025 01:36:02 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sun, 05 Jan 2025 06:36:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 75366 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Mail-Followup-To: 75366@debbugs.gnu.org, eliz@gnu.org, hong@topbug.net Original-Received: via spool by 75366-done@debbugs.gnu.org id=D75366.173605892125225 (code D ref 75366); Sun, 05 Jan 2025 06:36:02 +0000 Original-Received: (at 75366-done) by debbugs.gnu.org; 5 Jan 2025 06:35:21 +0000 Original-Received: from localhost ([127.0.0.1]:59276 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tUKEL-0006Yn-Ce for submit@debbugs.gnu.org; Sun, 05 Jan 2025 01:35:21 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43432) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1tUKEJ-0006VS-Gc for 75366-done@debbugs.gnu.org; Sun, 05 Jan 2025 01:35:20 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tUKED-0003cY-Lq; Sun, 05 Jan 2025 01:35:13 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=6c4rb+k9kYBp4YVcE0++vSjBcuDaywVXeBfeal9EKdw=; b=e9VR+JoCJtjy 6pRRohe89Vi8erVmFRG1Z2sD4nrzzmmKU/dlH8oFixrgaqgIF9KwPem2qfuPzr2f4xjfDOgPQuuW7 ATZleiMxs4VV/pQinlXY1o6p71RgxMl54SZBsqR6soLyxauAC6CDdnzmIL2OeoHj+7DA6X/TqVej9 wgQaFDTyOSsr4A353DDlgQq+vGcB8IokdetfkV8z9lLo9bEvrZghkqM8IOTS03yEWQM+rjQb6liKK Fg55Lm4LeKyPf/SN8LlW5iM9QImny/3CeR6tyDECPpqpfLAtrZjgEznvgleiZyggEhiXeFzMDv1og LMZFt9R+riHFv7G0dQ+7Rg==; In-Reply-To: <87y0zqtfus.fsf@topbug.net> (message from Hong Xu on Sat, 04 Jan 2025 13:43:23 -0800) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:298498 Archived-At: > From: Hong Xu > 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 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.