unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Heime <heimeborgia@protonmail.com>
To: Heime via Users list for the GNU Emacs text editor
	<help-gnu-emacs@gnu.org>
Subject: Misleading single "\" in Emacs Manual Section 25.3
Date: Tue, 16 Jul 2024 08:50:15 +0000	[thread overview]
Message-ID: <Hrlyt0dnNrRJe06hUIsQ6Bcz9uEs9tAFRKYXx7aDiKmjGgOb8ut_v-nkjeKf6lyLO9ZQHpm1qpGLxDiPJRPLO_XZRFbwrph8l4-wICnRsUM=@protonmail.com> (raw)


The Elisp documentation "25.3 Substituting Key Bindings in Documentation" states
that  each '\' must be doubled when written in a string in Emacs Lisp. 

I find this a bit confusing because the section is about writing within the documentation
string.  Meaning that the "\" should be doubled.

Using "\[COMMAND]" will not work in the documentation.  One has to use "\\[COMMAND]"

The commands in the section with a single "\" is misleading.






             reply	other threads:[~2024-07-16  8:50 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-16  8:50 Heime [this message]
2024-07-16 10:31 ` Misleading single "\" in Emacs Manual Section 25.3 Eli Zaretskii
2024-07-16 12:39   ` Heime
2024-07-16 13:36     ` Eli Zaretskii
2024-07-16 13:53       ` Heime
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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to='Hrlyt0dnNrRJe06hUIsQ6Bcz9uEs9tAFRKYXx7aDiKmjGgOb8ut_v-nkjeKf6lyLO9ZQHpm1qpGLxDiPJRPLO_XZRFbwrph8l4-wICnRsUM=@protonmail.com' \
    --to=heimeborgia@protonmail.com \
    --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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).