unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Philipp Stephani <p.stephani2@gmail.com>
Cc: 20642@debbugs.gnu.org
Subject: bug#20642: 24.5; Please improve documentation for `pcase'
Date: Sun, 24 May 2015 22:27:49 -0400	[thread overview]
Message-ID: <jwvfv6ltn8y.fsf-monnier+emacsbugs@gnu.org> (raw)
In-Reply-To: <m24mn25ko1.fsf@gmail.com> (Philipp Stephani's message of "Sun, 24 May 2015 12:34:06 +0200")

>    Perform ML-style pattern matching on EXP.
> Users are probably not aware what 'ML-style pattern matching' is.

Indeed.  But this "ML-style" is the only useful thing I can think
to add to this first line.  I don't think removing it will help anyone.

> Please add an introduction without referring to ML.

Feel free to suggest a replacement, but remember it has to fit on
a single line.

>    CASES is a list of elements of the form (UPATTERN CODE...).
> Please document the motivation for the existence and nomenclature or
> UPatterns and QPatterns.

In Emacs-25, the docstring has been indirectly modified, so the QPAT now
is only documented in a separate section about the backquote pattern.
You might like to take a look in that version, to see if it makes more
sense that way.


        Stefan





  parent reply	other threads:[~2015-05-25  2:27 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-24 10:34 bug#20642: 24.5; Please improve documentation for `pcase' Philipp Stephani
2015-05-25  2:08 ` Stefan Monnier
2015-05-25  2:27 ` Stefan Monnier [this message]
2015-06-21 13:07   ` Philipp Stephani
2015-06-21 13:08     ` Philipp Stephani
2015-06-22  1:19       ` 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

  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=jwvfv6ltn8y.fsf-monnier+emacsbugs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=20642@debbugs.gnu.org \
    --cc=p.stephani2@gmail.com \
    /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).