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

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Reported by: Stefan Kangas <stefan@HIDDEN>; dated Mon, 27 Dec 2021 15:25:02 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 52821 <at> debbugs.gnu.org:


Received: (at 52821) by debbugs.gnu.org; 29 Dec 2021 16:02:52 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Wed Dec 29 11:02:52 2021
Received: from localhost ([127.0.0.1]:50038 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1n2bPg-0005TG-1A
	for submit <at> debbugs.gnu.org; Wed, 29 Dec 2021 11:02:52 -0500
Received: from quimby.gnus.org ([95.216.78.240]:43244)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <larsi@HIDDEN>) id 1n2bPV-0005J3-6K
 for 52821 <at> debbugs.gnu.org; Wed, 29 Dec 2021 11:02:51 -0500
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org;
 s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date:
 References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding:
 Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender:
 Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:
 List-Subscribe:List-Post:List-Owner:List-Archive;
 bh=Ta9wG+slznui8tJHsp91uoa+cMsMMTuE49shi1x88LQ=; b=nXY2o4PW7XG9XXym92Xn+g+B1h
 IW079S3nlbAGkUL85Ad9kEDr1MxZD8S0qnet/ePjFCl70G/ES7dsstc4h5866m4uLsrjHXnFoRCY8
 0JMobnorTOTa5BWRhz4p3KoqPQbTA7STwe0u1VmFT+kWRdr6bnPw5enMVHAPY7iALCPA=;
Received: from [84.212.220.105] (helo=xo)
 by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.92) (envelope-from <larsi@HIDDEN>)
 id 1n2bPM-0007Qt-Mz; Wed, 29 Dec 2021 17:02:35 +0100
From: Lars Ingebrigtsen <larsi@HIDDEN>
To: Stefan Kangas <stefan@HIDDEN>
Subject: Re: bug#52821: Should "(elisp) Keymaps" describe key sequences first?
References: <CADwFkmmNG8TRpiphZPbadywnj4qXG2D6frtGO=ZU-hY3_FMzzg@HIDDEN>
X-Now-Playing: Four Tet's _Rounds_: "Unspoken"
Date: Wed, 29 Dec 2021 17:02:32 +0100
In-Reply-To: <CADwFkmmNG8TRpiphZPbadywnj4qXG2D6frtGO=ZU-hY3_FMzzg@HIDDEN>
 (Stefan Kangas's message of "Mon, 27 Dec 2021 07:24:22 -0800")
Message-ID: <875yr75rhj.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org",
 has NOT identified this incoming email as spam.  The original
 message has been attached to this so you can view it or label
 similar future email.  If you have any questions, see
 @@CONTACT_ADDRESS@@ for details.
 Content preview: Stefan Kangas <stefan@HIDDEN> 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 m [...] 
 Content analysis details:   (-2.9 points, 5.0 required)
 pts rule name              description
 ---- ---------------------- --------------------------------------------------
 -1.0 ALL_TRUSTED            Passed through trusted hosts only via SMTP
 -1.9 BAYES_00               BODY: Bayes spam probability is 0 to 1%
 [score: 0.0000]
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 52821
Cc: 52821 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

Stefan Kangas <stefan@HIDDEN> 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.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#52821; Package emacs. Full text available.

Message received at 52821 <at> debbugs.gnu.org:


Received: (at 52821) by debbugs.gnu.org; 28 Dec 2021 04:20:45 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Dec 27 23:20:45 2021
Received: from localhost ([127.0.0.1]:44849 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1n23yf-0002v8-91
	for submit <at> debbugs.gnu.org; Mon, 27 Dec 2021 23:20:45 -0500
Received: from eggs.gnu.org ([209.51.188.92]:41880)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <rms@HIDDEN>) id 1n23ya-0002ut-8t
 for 52821 <at> debbugs.gnu.org; Mon, 27 Dec 2021 23:20:43 -0500
Received: from [2001:470:142:3::e] (port=53506 helo=fencepost.gnu.org)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <rms@HIDDEN>)
 id 1n23yT-0002C4-OC; Mon, 27 Dec 2021 23:20:34 -0500
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=Date:References:Subject:In-Reply-To:To:From:
 mime-version; bh=tfCahPm/vJtyyq8NQDMUuc4pepkIC+6W3yIZu1wmwwk=; b=dgQrCdfQ1wLL
 Xa1P2oX1hmJxGBBzsGSTQ4ozwBmpi9VRjnJerwxarCPMsT4Fz4V+N5RMUBLLsGg/M1kbc4V/0/Hps
 nacnDueWxXN3y+49610EvMABoyUnACFk6AEEJ1zN9pZ3fyHqDwX8pKr8Sx0jUP3Eom+vc0M+U1ZRb
 qJrsispMasqh0Z5pIu1NTVA9nttj9LUTb8/l5o2GAXvYXX7mLVQnZrUhI6SQ3RnJWH/aWsLVA3617
 ZLd9nKWQBCASL2Zpg7fF2sRqwjDPtrNw/TTuSN1Q9/VmrdxquUuRgcK/xHNUjcKisFhBQ7GuqdPS4
 VmIsSB+M1sdDueqQ4/PxDw==;
Received: from rms by fencepost.gnu.org with local (Exim 4.90_1)
 (envelope-from <rms@HIDDEN>)
 id 1n23yT-0007OD-La; Mon, 27 Dec 2021 23:20:33 -0500
Content-Type: text/plain; charset=Utf-8
From: Richard Stallman <rms@HIDDEN>
To: Stefan Kangas <stefan@HIDDEN>
In-Reply-To: <CADwFkmmNG8TRpiphZPbadywnj4qXG2D6frtGO=ZU-hY3_FMzzg@HIDDEN>
 (message from Stefan Kangas on Mon, 27 Dec 2021 07:24:22 -0800)
Subject: Re: bug#52821: Should "(elisp) Keymaps" describe key sequences first?
References: <CADwFkmmNG8TRpiphZPbadywnj4qXG2D6frtGO=ZU-hY3_FMzzg@HIDDEN>
Message-Id: <E1n23yT-0007OD-La@HIDDEN>
Date: Mon, 27 Dec 2021 23:20:33 -0500
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 52821
Cc: 52821 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Reply-To: rms@HIDDEN
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > 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,

A key sequence is a Lisp object, and it's not internal -- quite a few
programs operate on them.

The description in that node is confused between describing the
Lisp object itself and describing its printed representation.
Perhaps this node should describe the Lisp object format
and the issue of printing and inputting them should be elsewhere.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)






Information forwarded to bug-gnu-emacs@HIDDEN:
bug#52821; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 27 Dec 2021 15:24:31 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Dec 27 10:24:31 2021
Received: from localhost ([127.0.0.1]:43965 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1n1rrS-0004Ns-Ul
	for submit <at> debbugs.gnu.org; Mon, 27 Dec 2021 10:24:31 -0500
Received: from lists.gnu.org ([209.51.188.17]:53572)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <stefankangas@HIDDEN>) id 1n1rrP-0004NW-0Y
 for submit <at> debbugs.gnu.org; Mon, 27 Dec 2021 10:24:27 -0500
Received: from eggs.gnu.org ([209.51.188.92]:44658)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <stefankangas@HIDDEN>)
 id 1n1rrO-0000WE-RT
 for bug-gnu-emacs@HIDDEN; Mon, 27 Dec 2021 10:24:26 -0500
Received: from mail-pg1-f179.google.com ([209.85.215.179]:45015)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.90_1) (envelope-from <stefankangas@HIDDEN>)
 id 1n1rrL-000591-Qk
 for bug-gnu-emacs@HIDDEN; Mon, 27 Dec 2021 10:24:26 -0500
Received: by mail-pg1-f179.google.com with SMTP id m15so13742496pgu.11
 for <bug-gnu-emacs@HIDDEN>; Mon, 27 Dec 2021 07:24:23 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20210112;
 h=x-gm-message-state:from:mime-version:date:message-id:subject:to;
 bh=BRAXARY3p/U97fjdLmxoUO5vhcbEvks/j+AjoNSxj7g=;
 b=lyff7rHn5Zt0cyaNQBZPrrcuw74fzZ+2HhcJZrAaUjp1zlrRVepFrYnqhX8CaUGJ+Z
 Dp9lLNWg82EPTsMCuBpLTaPynADC4rtvMw0Xq2mfk5FrqeLwm3olVAP9CUgl7I17+i9X
 1n6EJ1tY04LKhiZGEHqH7bKUy8hRmwNa2oBrsdrnbhcgzPNkBeW+YQU8x/AWR3vD3HW0
 D/LfjuZY72TGCJcmDbhgBiQ6YZ5VS/H88655zPpWugRTfTVImm+PZBE7M7QOWPjJzB9y
 5EAEhfJCD51zNgc03gwhN00JRWy/WXFzc0eihOEJ+GOTItCTFEbBsAHNM4OJxJ4xJuV+
 /sEw==
X-Gm-Message-State: AOAM53105WSna2vDFXO1qt9HlNniG1N33ySkktdxAKNfd8A6N55yyty2
 JtKEqOhAvSUd1uzsowCms0sLZV/hD+kV6MC9A471NZKP
X-Google-Smtp-Source: ABdhPJxMND4ETzpXKJpSGvaMso7rqBeR8G23AUOw67NXUDhXMoiTrrEocus5S86m+ujElcWosfbKdfVXPhIbF+NAbXc=
X-Received: by 2002:a63:4b42:: with SMTP id k2mr15796258pgl.591.1640618662528; 
 Mon, 27 Dec 2021 07:24:22 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Mon, 27 Dec 2021 07:24:22 -0800
From: Stefan Kangas <stefan@HIDDEN>
MIME-Version: 1.0
Date: Mon, 27 Dec 2021 07:24:22 -0800
Message-ID: <CADwFkmmNG8TRpiphZPbadywnj4qXG2D6frtGO=ZU-hY3_FMzzg@HIDDEN>
Subject: Should "(elisp) Keymaps" describe key sequences first?
To: bug-gnu-emacs@HIDDEN
Content-Type: text/plain; charset="UTF-8"
Received-SPF: pass client-ip=209.85.215.179;
 envelope-from=stefankangas@HIDDEN; helo=mail-pg1-f179.google.com
X-Spam_score_int: -13
X-Spam_score: -1.4
X-Spam_bar: -
X-Spam_report: (-1.4 / 5.0 requ) BAYES_00=-1.9,
 FREEMAIL_FORGED_FROMDOMAIN=0.248, FREEMAIL_FROM=0.001,
 HEADER_FROM_DIFFERENT_DOMAINS=0.249, RCVD_IN_DNSWL_NONE=-0.0001,
 RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=no autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -0.8 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.8 (-)

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?




Acknowledgement sent to Stefan Kangas <stefan@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#52821; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Wed, 29 Dec 2021 16:15:02 UTC

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