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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefan <at> marxist.se>
Subject: bug#52821: closed (Re: bug#52821: Should "(elisp) Keymaps"
 describe key sequences first?)
Date: Sat, 01 Mar 2025 05:38:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#52821: Should "(elisp) Keymaps" describe key sequences first?

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 52821 <at> debbugs.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 <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.

[Message part 3 (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?

Previous Next

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