From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Heime Newsgroups: gmane.emacs.help Subject: Misleading single "\" in Emacs Manual Section 25.3 Date: Tue, 16 Jul 2024 12:39:08 +0000 Message-ID: References: <865xt5iq6k.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28179"; mail-complaints-to="usenet@ciao.gmane.io" Cc: help-gnu-emacs@gnu.org To: Eli Zaretskii Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jul 16 14:39:52 2024 Return-path: Envelope-to: geh-help-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 1sThTD-00076Z-Ro for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 16 Jul 2024 14:39:51 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sThSg-0006AR-0g; Tue, 16 Jul 2024 08:39:18 -0400 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 1sThSe-00065P-EW for help-gnu-emacs@gnu.org; Tue, 16 Jul 2024 08:39:16 -0400 Original-Received: from mail-40138.protonmail.ch ([185.70.40.138]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sThSc-0002ZQ-0F for help-gnu-emacs@gnu.org; Tue, 16 Jul 2024 08:39:16 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1721133550; x=1721392750; bh=xIAeiJsueaMf6+vUTBZIX4Ela7OJoMlVkkQq89ZdjCI=; h=Date:To:From:Cc:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=kkJXonkUO9ZZAT9qlniZ2lafoHj4g7bp5uOYL3hw0KDtcFj7QUuRcLn68u9jg9FCy mtJX9npnXGYdzrAUxRF+vyxvIXHVAkAq5441RTo8xg5QQFIIhbdwX+cNfS8WIxX279 Q98Nw0bulkYxcGQjwZ8HK609TiNQvsmoDsPgREf+1dNEmRQNuR5maE1KGgHyNK9dUe 8dyODQqEwhGSSBkfLekpgNptF/lRgS2g0jcy2T0kuKEbiPuS7vxZk5FSiUbuksEWLd A/T386zmueleJXx6PbGThs0wdEnW4+SPYxIYtE/YltF3L1mXwX2qnAplpJVNmBG0tN 2WOT+2NGFZD9g== In-Reply-To: <865xt5iq6k.fsf@gnu.org> Feedback-ID: 57735886:user:proton X-Pm-Message-ID: d9fc9842b9f5cbd14d2ba4ffa73f34bad607f6e7 Received-SPF: pass client-ip=185.70.40.138; envelope-from=heimeborgia@protonmail.com; helo=mail-40138.protonmail.ch X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.help:147252 Archived-At: On Tuesday, July 16th, 2024 at 10:31 PM, Eli Zaretskii wrote= : > > Date: Tue, 16 Jul 2024 08:50:15 +0000 > > From: Heime heimeborgia@protonmail.com > >=20 > > The Elisp documentation "25.3 Substituting Key Bindings in Documentatio= n" states > > that each '\' must be doubled when written in a string in Emacs Lisp. > >=20 > > I find this a bit confusing because the section is about writing within= the documentation > > string. Meaning that the "\" should be doubled. > >=20 > > Using "\[COMMAND]" will not work in the documentation. One has to use "= \\[COMMAND]" > >=20 > > The commands in the section with a single "\" is misleading. >=20 >=20 > I don't think they are misleading, since the text says right away that > each backslash in the forms above needs to be doubled. It is already confusing enough on how many \ are needed for some expression= s to be printed (e.g. for regex expressions). =20 When the topic is about documentation strings, the commands should conform = to what one would type in the documentation string. =20 After that, it can be stated that the string processing phase will strip aw= ay one layer of backslashes. It would be more understandable this way. Some readers wi= ll initially=20 think that they should write \=3D in their string directly.