From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.devel Subject: Re: Replace trivial pcase occurrences in the Emacs sources Date: Tue, 30 Oct 2018 19:00:26 +0000 Message-ID: <20181030190026.GD5705@ACM> References: <86mur137n8.fsf@gmail.com> <20181029130132.GB4195@ACM> <20181029134722.GC4195@ACM> <20181030180941.GA5705@ACM> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: blaine.gmane.org 1540925935 18500 195.159.176.226 (30 Oct 2018 18:58:55 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 30 Oct 2018 18:58:55 +0000 (UTC) User-Agent: Mutt/1.10.1 (2018-07-13) Cc: emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Oct 30 19:58:51 2018 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gHZE1-0004eA-KM for ged-emacs-devel@m.gmane.org; Tue, 30 Oct 2018 19:58:49 +0100 Original-Received: from localhost ([::1]:55040 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gHZG8-0002us-2j for ged-emacs-devel@m.gmane.org; Tue, 30 Oct 2018 15:01:00 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57745) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gHZG0-0002ul-Nx for emacs-devel@gnu.org; Tue, 30 Oct 2018 15:00:53 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gHZFu-0002qQ-DC for emacs-devel@gnu.org; Tue, 30 Oct 2018 15:00:52 -0400 Original-Received: from colin.muc.de ([193.149.48.1]:13887 helo=mail.muc.de) by eggs.gnu.org with smtp (Exim 4.71) (envelope-from ) id 1gHZFt-000206-RL for emacs-devel@gnu.org; Tue, 30 Oct 2018 15:00:46 -0400 Original-Received: (qmail 53690 invoked by uid 3782); 30 Oct 2018 19:00:21 -0000 Original-Received: from acm.muc.de (p5B1479F4.dip0.t-ipconnect.de [91.20.121.244]) by colin.muc.de (tmda-ofmipd) with ESMTP; Tue, 30 Oct 2018 20:00:20 +0100 Original-Received: (qmail 5991 invoked by uid 1000); 30 Oct 2018 19:00:26 -0000 Content-Disposition: inline In-Reply-To: X-Delivery-Agent: TMDA/1.1.12 (Macallan) X-Primary-Address: acm@muc.de X-detected-operating-system: by eggs.gnu.org: FreeBSD 9.x [fuzzy] X-Received-From: 193.149.48.1 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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" Xref: news.gmane.org gmane.emacs.devel:230847 Archived-At: Hello, Stefan. On Tue, Oct 30, 2018 at 14:17:10 -0400, Stefan Monnier wrote: > > Not everybody is familiar with dolist by any means. Is dolist's doc > > string of sufficiently high quality to act as this basis? > If dolist's docstring is not good enough, then I don't think it's > pcase-dolist's job to fix it. I think everybody would agree with this point. > >> We do have to keep the reference to `pcase` because we don't want to > >> repeat the definition of what a pcase pattern can look like. > > Yes, I think that's right. > > Things I believe MUST appear explicitly in the doc string for > > pcase-dolist: > > 1. It is a loop over the elements of LIST, which must be a list. > > 2. It attempts to match the current list element with the supplied > > PATTERN, which must be a valid pcase style pattern. > > 3. The BODY forms are evaluated for each element of the list. > > 4. The purpose of the matching is to create bindings for symbols, and > > these bindings are in force when the BODY forms are evaluated. > > 5. When a pattern match fails, ..... (This needs to be stated). > This is highly redundant w.r.t pcase-let and dolist. Maybe, but so what? Doc strings should be as far as is reasonable self contained. Have a look at the doc strings for let and let*. They have a great deal in common, but each is self contained. > Fine for the manual, but not for docstrings. You seem to be arguing that doc strings needn't say what de{fun,macro,var}s do and are, as long as the meaning can be acquired through the traversal of a directed acyclic graph of linked doc strings. Maybe you find this a good way of acquiring information, but I certainly don't. I just get angry and frustrated, and I'm sure I'm not the only one. > You can click on the link to the docstring of `dolist` and `pcase` > (tho, I now see the link should go to `pcase-let` instead). I can, but I'd much rather find the information in a coherent form in a single place. That's what doc strings are for. > Stefan -- Alan Mackenzie (Nuremberg, Germany).