From: Andreas Schwab <schwab@linux-m68k.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 'Lars Magne Ingebrigtsen' <larsi@gnus.org>, 8935@debbugs.gnu.org
Subject: bug#8935: 24.0.50; `substitute-command-keys' doc
Date: Fri, 15 Jul 2011 22:09:46 +0200 [thread overview]
Message-ID: <m2fwm7qp9x.fsf@igel.home> (raw)
In-Reply-To: <52B42160EFF24B69AE5BBAC0A0D03346@us.oracle.com> (Drew Adams's message of "Fri, 15 Jul 2011 12:17:46 -0700")
"Drew Adams" <drew.adams@oracle.com> writes:
> Escaping a character means making it act normally, not specially. Only the \
> acts specially,
Wrong.
> and it does so only when it precedes [, {, etc.
Right. And only this is of interest.
> It is _enough_ to say that \= escapes a \, preventing it from
> introducing a substitution when followed by =, [, etc.
No, this is the wrong thing to do. The doc string should say how to
produce a value that contains the two character sequences '\=' or '\['.
That's the *whole* point of the examples (and these are *examples*, not
specification).
You don't need '\=' to produce a backslash in the value. So that is
useless to say so.
A doc string needs to get to the point, not be technically correct.
Andreas.
--
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756 01D3 44D5 214B 8276 4ED5
"And now for something completely different."
next prev parent reply other threads:[~2011-07-15 20:09 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-06-25 21:29 bug#8935: 24.0.50; `substitute-command-keys' doc Drew Adams
2011-07-15 14:32 ` Lars Magne Ingebrigtsen
2011-07-15 15:33 ` Andreas Schwab
2011-07-15 16:00 ` Drew Adams
2011-07-15 16:35 ` Lars Magne Ingebrigtsen
2011-07-15 16:35 ` Lars Magne Ingebrigtsen
2011-07-15 17:23 ` Drew Adams
2011-07-15 17:28 ` Lars Magne Ingebrigtsen
2011-07-15 18:38 ` Andreas Schwab
2011-07-15 19:17 ` Drew Adams
2011-07-15 20:09 ` Andreas Schwab [this message]
2011-07-15 19:18 ` Drew Adams
2011-07-15 19:22 ` Lars Magne Ingebrigtsen
2011-07-15 19:25 ` Drew Adams
2011-07-18 13:55 ` Stefan Monnier
2011-07-18 14:27 ` Andreas Schwab
2011-07-18 16:20 ` Stefan Monnier
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=m2fwm7qp9x.fsf@igel.home \
--to=schwab@linux-m68k.org \
--cc=8935@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=larsi@gnus.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.