From: John Mastro <john.b.mastro@gmail.com>
To: 25462@debbugs.gnu.org
Cc: Alan Mackenzie <acm@muc.de>,
Noam Postavsky <npostavs@users.sourceforge.net>
Subject: bug#25462: Out of date doc string for "`".
Date: Tue, 17 Jan 2017 13:17:27 -0800 [thread overview]
Message-ID: <CAOj2CQRJQJP3GEaY-9XHsvzT=-fOyOwLOkh6L0E7FNYxF_PvAQ@mail.gmail.com> (raw)
In-Reply-To: <CAM-tV-_L4hOe9XV7aSFYRjaQ1xG_ve6KbD26w5C6PZorB0Y26A@mail.gmail.com>
Noam Postavsky <npostavs@users.sourceforge.net> wrote:
> On Mon, Jan 16, 2017 at 4:30 PM, Alan Mackenzie <acm@muc.de> wrote:
>> Hello, Emacs.
>>
>> The doc string for "`" has become partial.
>>
>> It fails to mention that "`" has a radically different meaning when used
>> in certain parts of a `pcase', and probably quite a few other similar
>> macros.
>
> I don't think that makes sense. Similarly, we don't add a mention of
> `cl-loop's use of `if' in the docstring of `if', because that's not
> part of the `if' special form. It's just a use of `if' as a plain
> symbol.
Since the misunderstanding is believing that "`" is more special than it
is, maybe something calling out its ordinariness could be appropriate
(and throw in a reference to pcase as an example?)
I don't think this is great, but, as an example:
Note that `\\=`' is any ordinary Lisp symbol and thus may be treated
as data or given different meanings in particular contexts. For
instance, it has a special meaning inside `pcase' patterns.
next prev parent reply other threads:[~2017-01-17 21:17 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-16 21:30 bug#25462: Out of date doc string for "`" Alan Mackenzie
2017-01-16 21:52 ` Noam Postavsky
2017-01-17 20:05 ` Alan Mackenzie
2017-01-18 2:04 ` npostavs
2017-01-17 21:17 ` John Mastro [this message]
2017-01-18 20:55 ` Alan Mackenzie
2017-01-18 22:14 ` Noam Postavsky
2017-01-18 20:40 ` Alan Mackenzie
2021-09-25 16:12 ` Stefan Kangas
2021-09-26 6:46 ` Lars Ingebrigtsen
2021-09-26 7:17 ` Stefan Kangas
2021-09-26 20:31 ` Alan Mackenzie
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='CAOj2CQRJQJP3GEaY-9XHsvzT=-fOyOwLOkh6L0E7FNYxF_PvAQ@mail.gmail.com' \
--to=john.b.mastro@gmail.com \
--cc=25462@debbugs.gnu.org \
--cc=acm@muc.de \
--cc=npostavs@users.sourceforge.net \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
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).