GNU bug report logs - #20642
24.5; Please improve documentation for `pcase'

Previous Next

Package: emacs;

Reported by: Philipp Stephani <p.stephani2 <at> gmail.com>

Date: Sun, 24 May 2015 10:35:02 UTC

Severity: wishlist

Merged with 18288

Found in version 24.5

Done: Stefan Monnier <monnier <at> iro.umontreal.ca>

Bug is archived. No further changes may be made.

Full log


Message #19 received at 20642 <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 20642 <at> debbugs.gnu.org
Subject: Re: bug#20642: 24.5; Please improve documentation for `pcase'
Date: Sun, 21 Jun 2015 13:08:34 +0000
[Message part 1 (text/plain, inline)]
Philipp Stephani <p.stephani2 <at> gmail.com> schrieb am So., 21. Juni 2015 um
15:07 Uhr:

> Stefan Monnier <monnier <at> iro.umontreal.ca> schrieb am Mo., 25. Mai 2015 um
> 04:27 Uhr:
>
>> >    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.
>>
>>
>>
> I think the current wording is better, thanks.
>

Sorry, wanted to say "the *new* wording (in Emacs 25) is better".
[Message part 2 (text/html, inline)]

This bug report was last modified 9 years and 337 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.