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: Re: Misleading single "\" in Emacs Manual Section 25.3 Date: Tue, 16 Jul 2024 14:21:56 +0000 Message-ID: References: <865xt5iq6k.fsf@gnu.org> <861q3tihm1.fsf@gnu.org> <64arC1lNb6gJY7f3elKXIvGBv-FDOVVQ4wz33v6nPUylX1l_Kfn3saV9a_-k_jRgaKBamhcH3MhBfNyrTWz-CYwLBBvK1p0csC56bXtuHD0=@protonmail.com> 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="36035"; mail-complaints-to="usenet@ciao.gmane.io" Cc: help-gnu-emacs@gnu.org, Heime To: Eli Zaretskii Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jul 16 16:22:38 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 1sTj4f-00097w-VU for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 16 Jul 2024 16:22:37 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTj4F-0006Zp-ST; Tue, 16 Jul 2024 10:22:11 -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 1sTj4D-0006Wl-JL for help-gnu-emacs@gnu.org; Tue, 16 Jul 2024 10:22:09 -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 1sTj4B-0007Dm-9P; Tue, 16 Jul 2024 10:22:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1721139724; x=1721398924; bh=GCCNp/X3oGwwUXyko1p62UmUgYM3T3X/TanXBpqMcdI=; 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=YdaYUd3C1cWnrEbA8oWc84P+9vhM7ypy1vjHNiKpKQAgl+GCnnuc6qTbLjmBHFhsW i3Tz/PICx2h0LU6VV1EiFYZA8lZ0Waz+4ZVjQBcCZ7Amhol6zg4qlufmuzv8tKOw7e qztoiUoVc8eeriS0lpCnKt5+eqb+H8eKxGVFi5phIDy4IydEmwG4sfKlTFXPwiIVvp Wj9IMH5QHlxRwznd3FeB9fGYBUNVVVMHxG0+Huvut4BXMW8bXIbNzf/fwyEQXapv1y rF7lyOLGZ3zHGa+L5YNlKInBNHOQYyqYIYfV9vRyrHN8SAUely64RZpwUrWzfKIsyk F1uUMQ3yDM1Ow== In-Reply-To: <64arC1lNb6gJY7f3elKXIvGBv-FDOVVQ4wz33v6nPUylX1l_Kfn3saV9a_-k_jRgaKBamhcH3MhBfNyrTWz-CYwLBBvK1p0csC56bXtuHD0=@protonmail.com> Feedback-ID: 57735886:user:proton X-Pm-Message-ID: 7b7260c220d6b59d6bbe0aab53e21c539c686d42 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:147255 Archived-At: On Wednesday, July 17th, 2024 at 1:53 AM, Heime wrote: > On Wednesday, July 17th, 2024 at 1:36 AM, Eli Zaretskii eliz@gnu.org wrot= e: >=20 > > > Date: Tue, 16 Jul 2024 12:39:08 +0000 > > > From: Heime heimeborgia@protonmail.com > > > Cc: help-gnu-emacs@gnu.org > > >=20 > > > > > The commands in the section with a single "\" is misleading. > > > >=20 > > > > I don't think they are misleading, since the text says right away t= hat > > > > each backslash in the forms above needs to be doubled. > > >=20 > > > It is already confusing enough on how many \ are needed for some expr= essions to be > > > printed (e.g. for regex expressions). > > >=20 > > > When the topic is about documentation strings, the commands should co= nform to what > > > one would type in the documentation string. > >=20 > > I disagree. > >=20 > > > Some readers will initially think that they should write \=3D in thei= r > > > string directly. > >=20 > > Only if they fail to pay attention to the note about doubling the > > backslashes. >=20 >=20 > Or me can leave everything as is, but elaborate further about how the > processing phase of a docstring will strip away one layer of backslashes. >=20 > Then show couple of examples >=20 > Entry | Interpretation > -------------+---------------- > \\[COMMAND] | \[COMMAND] > \\[\\-\\] | \[\-\] >=20 This addition could be introduced "When emacs processes a docstring, it removes (strips away) one level (layer) of backslashes. This means that each backslash written in the docstring needs to be doubled to ensure the correct number of backslashes are interpreted."