GNU bug report logs - #52821
Should "(elisp) Keymaps" describe key sequences first?

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefan <at> marxist.se>

Date: Mon, 27 Dec 2021 15:25:02 UTC

Severity: normal

Fixed in version 30.2

Done: Stefan Kangas <stefankangas <at> gmail.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#52821: closed (Should "(elisp) Keymaps" describe key
 sequences first?)
Date: Sat, 01 Mar 2025 05:38:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Fri, 28 Feb 2025 21:37:34 -0800
with message-id <CADwFkm=MctStK7qyfYiH4hdbK71wj+B0Qq2o19abfr9e4FvtQQ <at> mail.gmail.com>
and subject line Re: bug#52821: Should "(elisp) Keymaps" describe key sequences first?
has caused the debbugs.gnu.org bug report #52821,
regarding Should "(elisp) Keymaps" describe key sequences first?
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
52821: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=52821
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: Should "(elisp) Keymaps" describe key sequences first?
Date: Mon, 27 Dec 2021 07:24:22 -0800
Now that we promote the new keymap-* functions, does it really make
sense to start the section (info "(elisp) Keymaps") with a description
of key sequences?

This seems to now be considered more of an internal detail, and the
thing that should be exposed to (new) ELisp code is rather the new key
description format accepted by `key-valid-p'.

I'm thinking it should be moved further down, perhaps in a section next
to this one:

* Low-Level Key Binding::       Legacy key syntax description.

There is a good description on the "new" key format in
(info "(elisp) Changing Key Bindings").  Perhaps it should
be moved up instead?


[Message part 3 (message/rfc822, inline)]
From: Stefan Kangas <stefankangas <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 52821-done <at> debbugs.gnu.org
Subject: Re: bug#52821: Should "(elisp) Keymaps" describe key sequences first?
Date: Fri, 28 Feb 2025 21:37:34 -0800
Version: 30.2

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Stefan Kangas <stefan <at> marxist.se> writes:
>
>> Now that we promote the new keymap-* functions, does it really make
>> sense to start the section (info "(elisp) Keymaps") with a description
>> of key sequences?
>>
>> This seems to now be considered more of an internal detail, and the
>> thing that should be exposed to (new) ELisp code is rather the new key
>> description format accepted by `key-valid-p'.
>>
>> I'm thinking it should be moved further down, perhaps in a section next
>> to this one:
>>
>> * Low-Level Key Binding::       Legacy key syntax description.
>
> Yes, sounds good to me.
>
>> There is a good description on the "new" key format in
>> (info "(elisp) Changing Key Bindings").  Perhaps it should
>> be moved up instead?
>
> Yup.

Now done on emacs-30.  I'm therefore closing this bug report.


This bug report was last modified 78 days ago.

Previous Next


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