all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Heime <heimeborgia@protonmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: help-gnu-emacs@gnu.org
Subject: Re: Misleading single "\" in Emacs Manual Section 25.3
Date: Tue, 16 Jul 2024 13:53:11 +0000	[thread overview]
Message-ID: <64arC1lNb6gJY7f3elKXIvGBv-FDOVVQ4wz33v6nPUylX1l_Kfn3saV9a_-k_jRgaKBamhcH3MhBfNyrTWz-CYwLBBvK1p0csC56bXtuHD0=@protonmail.com> (raw)
In-Reply-To: <861q3tihm1.fsf@gnu.org>

On Wednesday, July 17th, 2024 at 1:36 AM, Eli Zaretskii <eliz@gnu.org> wrote:

> > Date: Tue, 16 Jul 2024 12:39:08 +0000
> > From: Heime heimeborgia@protonmail.com
> > Cc: help-gnu-emacs@gnu.org
> > 
> > > > The commands in the section with a single "\" is misleading.
> > > 
> > > 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 expressions to be
> > printed (e.g. for regex expressions).
> > 
> > When the topic is about documentation strings, the commands should conform to what
> > one would type in the documentation string.
> 
> 
> I disagree.
> 
> > Some readers will initially think that they should write \= in their
> > string directly.
> 
> 
> Only if they fail to pay attention to the note about doubling the
> backslashes.

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.

Then show couple of examples

  Entry        |  Interpretation
  -------------+----------------
  \\[COMMAND]  |  \[COMMAND]
  \\[\\-\\]    |  \[\-\]





  reply	other threads:[~2024-07-16 13:53 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-16  8:50 Misleading single "\" in Emacs Manual Section 25.3 Heime
2024-07-16 10:31 ` Eli Zaretskii
2024-07-16 12:39   ` Heime
2024-07-16 13:36     ` Eli Zaretskii
2024-07-16 13:53       ` Heime [this message]
2024-07-16 14:21         ` Heime
2024-07-16 14:36           ` Eli Zaretskii
2024-07-16 15:21             ` Heime
2024-07-17  2:58               ` Stefan Monnier via Users list for the GNU Emacs text editor

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='64arC1lNb6gJY7f3elKXIvGBv-FDOVVQ4wz33v6nPUylX1l_Kfn3saV9a_-k_jRgaKBamhcH3MhBfNyrTWz-CYwLBBvK1p0csC56bXtuHD0=@protonmail.com' \
    --to=heimeborgia@protonmail.com \
    --cc=eliz@gnu.org \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.