From: Robert Pluim <rpluim@gmail.com>
To: Panagiotis Koutsourakis <kutsurak@slartibartfast.net>
Cc: 60859@debbugs.gnu.org
Subject: bug#60859: [PATCH] Remove reference to the kbd function from documentation
Date: Tue, 17 Jan 2023 18:16:54 +0100 [thread overview]
Message-ID: <87mt6haxo9.fsf@gmail.com> (raw)
In-Reply-To: <87fsc9jg6p.fsf@panoramix.zarniwoop.org> (Panagiotis Koutsourakis's message of "Tue, 17 Jan 2023 18:09:50 +0200")
>>>>> On Tue, 17 Jan 2023 18:09:50 +0200, Panagiotis Koutsourakis <kutsurak@slartibartfast.net> said:
Panagiotis> The current situation is that the explanation refers to "kbd" as an easy
Panagiotis> way to write a key binding, but the code example has changed and makes
Panagiotis> no reference to it.
right
>>
>> How about
>>
>> --begin--
>> There are several syntaxes that can be used to specify the binding,
>> but the simplest and most consistent is the one accepted by
>> @code{kbd}, which is basically a series of characters separated by
>> spaces. Keys with modifiers can be specified by prepending the
>> modifier, such as @samp{C-} for Control, or @samp{M-} for Meta. For
>> example, to bind @samp{C-x} followed by @samp{a}, use
>>
>> @example
>> kbd("C-x a")
>> @end example
>> --end--
Panagiotis> This goes into some detail for a currently deprecated way to bind keys
Panagiotis> (or at least that's what the current lisp reference manual says).
Panagiotis> So, to recap:
Panagiotis> 1. I think currently there is a documentation bug: "kbd" is mentioned in
Panagiotis> text but not used in the example immediately following it.
yes
Panagiotis> 2. Other documentation sources (emacs lisp reference manual in emacs-29
Panagiotis> branch) explicitly state that the preferred way to bind keys in emacs 29
Panagiotis> is using "the syntax supported by 'key-valid-p'" and that "[the old
Panagiotis> functions] should not be used in new code." (section 23.13 of elisp
Panagiotis> reference in emacs-29)
yes
Panagiotis> So, assuming that we want the documentation as a whole to be consistent,
Panagiotis> I see two ways forward: either we eliminate or reduce the importance of
Panagiotis> the old functions in the user manual, or we remove the effective
Panagiotis> deprecation of the old functions in the emacs lisp reference manual and
Panagiotis> expand on the use of 'kbd', 'global-set-key' and 'define-key'.
Panagiotis> What do you think?
The syntax accepted by the new functions is that of `kbd', so as long
as that syntax is explained somewhere I guess we can remove references
to `kbd' itself.
Robert
--
next prev parent reply other threads:[~2023-01-17 17:16 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-16 11:15 bug#60859: [PATCH] Remove reference to the kbd function from documentation Panagiotis Koutsourakis
2023-01-16 14:47 ` Eli Zaretskii
2023-01-16 16:17 ` Panagiotis Koutsourakis
2023-01-16 16:56 ` Eli Zaretskii
2023-01-17 14:20 ` Panagiotis Koutsourakis
2023-01-17 14:56 ` Robert Pluim
2023-01-17 16:09 ` Panagiotis Koutsourakis
2023-01-17 17:16 ` Robert Pluim [this message]
2023-01-17 17:32 ` Eli Zaretskii
2023-01-17 19:40 ` Panagiotis Koutsourakis
2023-01-21 7:52 ` Eli Zaretskii
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=87mt6haxo9.fsf@gmail.com \
--to=rpluim@gmail.com \
--cc=60859@debbugs.gnu.org \
--cc=kutsurak@slartibartfast.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).