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: Sat, 19 Dec 2015 18:47:11 +0200 Message-ID: <83fuyyv10w.fsf@gnu.org> References: <20151216202605.GA3752@acm.fritz.box> <87fuyytq6b.fsf@web.de> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1450543622 17988 80.91.229.3 (19 Dec 2015 16:47:02 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 19 Dec 2015 16:47:02 +0000 (UTC) Cc: acm@muc.de, emacs-devel@gnu.org To: Michael Heerdegen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Dec 19 17:46:57 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 1aAKel-0006kG-6S for ged-emacs-devel@m.gmane.org; Sat, 19 Dec 2015 17:46:55 +0100 Original-Received: from localhost ([::1]:37883 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAKek-00081t-Mn for ged-emacs-devel@m.gmane.org; Sat, 19 Dec 2015 11:46:54 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43958) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAKeg-00081J-Ro for emacs-devel@gnu.org; Sat, 19 Dec 2015 11:46:51 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aAKed-0001Zu-Dx for emacs-devel@gnu.org; Sat, 19 Dec 2015 11:46:50 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:43669) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aAKed-0001Zq-Ak; Sat, 19 Dec 2015 11:46:47 -0500 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:3717 helo=HOME-C4E4A596F7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1aAKec-00057W-Cz; Sat, 19 Dec 2015 11:46:46 -0500 In-reply-to: <87fuyytq6b.fsf@web.de> (message from Michael Heerdegen on Sat, 19 Dec 2015 16:26:52 +0100) 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:196511 Archived-At: > From: Michael Heerdegen > Date: Sat, 19 Dec 2015 16:26:52 +0100 > Cc: emacs-devel@gnu.org > > As far as I understand how Stefan used to work, most of the semantics of > most of the pcase derivatives, like `pcase-let', are not yet 100% fixed, > we are not yet sure how useful we are, or if they may later be better be > replaced by other forms that are more general, etc. > > IMHO it's good to leave the documentation of the derivatives as is for > now. Grepping for "pcase-let" brings about 90 hits (including pcase-let*), so leaving that undocumented is no longer an option, IMO. > To be honest, I tweaked some of the pcase related documentation, and was > quite happy with it. I think the pcase docstring is quite good. Thank you for your efforts. > A tutorial is missing though, clearly. Tutorials are always good to have, but they cannot replace good documentation in the manual. We should strive to provide manuals that are self-contained and don't require any tutorial reading for acquiring a full understanding of an issue and an unimpeded capability of using it in Lisp programs.