unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Michael Heerdegen <michael_heerdegen@web.de>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: 20759@debbugs.gnu.org, Dmitry Gutov <dgutov@yandex.ru>
Subject: bug#20759: 25.0.50; pcase doc: (‘ QPAT) instead of (` QPAT)
Date: Fri, 12 Jun 2015 14:20:35 +0200	[thread overview]
Message-ID: <87eglh6ru4.fsf@web.de> (raw)
In-Reply-To: <5579C761.1070505@cs.ucla.edu> (Paul Eggert's message of "Thu, 11 Jun 2015 10:37:37 -0700")

Paul Eggert <eggert@cs.ucla.edu> writes:

> As the patch mentions, I'm puzzled about the syntax ‘(` PAT)’ in the
> docstring, since lread.c says that syntax is obsolete and ‘format’
> quotes the grave accent.  The attached patch causes C-h f to suggest
> the syntax ‘(\` PAT)’ which is "safer" in some sense, I suppose.  If
> it's intended that pcase usage omit the backslash, then I guess that
> ‘format’ and/or lread.c need to be updated accordingly.

Thanks for working on that.

Thinking again about this, maybe `PAT would be didactically better, in
this special case of the pcase doc.  People not being aware of backquote
being a reader macro should not think

   (pcase '(1 2) ((\` (1 2)) t))

is the "correct" way to use this (instead of

   (pcase '(1 2) (`(1 2) t))

).

I know that the doc of pcase is generated automatically, and your
(Paul's) patch makes this more consistent.

OTOH, we write 'VAL and not (\' VAL) some lines above in the same
documentation.


Regards,

Michael.





  reply	other threads:[~2015-06-12 12:20 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-07 15:41 bug#20759: 25.0.50; pcase doc: (‘ QPAT) instead of (` QPAT) Michael Heerdegen
2015-06-07 18:14 ` Glenn Morris
2015-06-07 18:18   ` Glenn Morris
2015-06-07 18:41     ` Michael Heerdegen
2015-06-07 20:42 ` Dmitry Gutov
2015-06-11 17:37 ` Paul Eggert
2015-06-12 12:20   ` Michael Heerdegen [this message]
2015-06-12 14:05     ` Stefan Monnier
2015-06-12 23:34     ` Paul Eggert
2015-06-13 14:12       ` Stefan Monnier
2015-06-13 16:36         ` Paul Eggert

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=87eglh6ru4.fsf@web.de \
    --to=michael_heerdegen@web.de \
    --cc=20759@debbugs.gnu.org \
    --cc=dgutov@yandex.ru \
    --cc=eggert@cs.ucla.edu \
    /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).