From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: The poor state of documentation of pcase like things. Date: Sun, 20 Dec 2015 05:38:39 +0200 Message-ID: <83vb7tu6v4.fsf@gnu.org> References: <20151216202605.GA3752@acm.fritz.box> <87fuz0ydvb.fsf@russet.org.uk> <83poy4xm60.fsf@gnu.org> <871tak15pb.fsf@gmx.us> <8360zwxgbu.fsf@gnu.org> <87vb7wdpz5.fsf@fencepost.gnu.org> <831takxccb.fsf@gnu.org> <87egej3dvb.fsf@russet.org.uk> <83h9jfwuab.fsf@gnu.org> <83r3iivg02.fsf@gnu.org> <87fuyyllat.fsf@fencepost.gnu.org> <83mvt6vdli.fsf@gnu.org> <878u4qnpml.fsf@russet.org.uk> <83wpsatat1.fsf@gnu.org> <87r3iim611.fsf@russet.org.uk> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1450582716 3488 80.91.229.3 (20 Dec 2015 03:38:36 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 20 Dec 2015 03:38:36 +0000 (UTC) Cc: dak@gnu.org, rasmus@gmx.us, emacs-devel@gnu.org To: phillip.lord@russet.org.uk (Phillip Lord) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 20 04:38:31 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1aAUpL-0003kE-HI for ged-emacs-devel@m.gmane.org; Sun, 20 Dec 2015 04:38:31 +0100 Original-Received: from localhost ([::1]:39522 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAUpK-0000tM-HN for ged-emacs-devel@m.gmane.org; Sat, 19 Dec 2015 22:38:30 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50194) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAUp7-0000t3-74 for emacs-devel@gnu.org; Sat, 19 Dec 2015 22:38:18 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aAUp4-0002IU-0s for emacs-devel@gnu.org; Sat, 19 Dec 2015 22:38:17 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:57527) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAUp3-0002IQ-UF; Sat, 19 Dec 2015 22:38:13 -0500 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:4277 helo=HOME-C4E4A596F7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1aAUp1-0004bx-SK; Sat, 19 Dec 2015 22:38:12 -0500 In-reply-to: <87r3iim611.fsf@russet.org.uk> (phillip.lord@russet.org.uk) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:196540 Archived-At: > From: phillip.lord@russet.org.uk (Phillip Lord) > Cc: , , > Date: Sat, 19 Dec 2015 22:23:54 +0000 > > > Sorry, I'm not following. If we think the second instance of > > "Conditionals" is not the best text, we can change it at will. Only > > the first one must me identical to the node name. The second one is > > "Conditionals" because it was produced by a program and I left it > > unchanged, but it can be changed if we want to. > > Simple change would be from: > > Conditionals > > * Pattern matching case statement:: How to use @code{pcase}. > > > to > > Pattern Matching > > * Conditional:: How to use @code{pcase} The last line can't be done, unless the node names are changed as well. Right now the pcase description is in the child node of "Conditionals" whose name is "Pattern matching case statement". Also, I think having 2 nodes named "Conditionals" and "Conditional" will be too confusing. > Pattern Matching > > (this would contain a generalised introduction and tutorial, based > around pcase) > > * List Clauses:: Destructuring Lists > * Predicates:: Matching with predicate functions > * Booleans:: and and or > * Guards:: I don't quite understand guards > * Conditionals:: pcase > * Binding:: pcase-let > * Lambda:: pcase-lambda These would be too short to justify a separate node, IMO. > * New Patterns:: pcase-macro, with description of seq and map support. We avoid using "new" in manuals, because they are that only for one release.