From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.bugs Subject: bug#25462: Out of date doc string for "`". Date: Tue, 17 Jan 2017 20:05:39 +0000 Message-ID: <20170117200539.GB4169@acm.fritz.box> References: <20170116213051.GB4747@acm.fritz.box> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: blaine.gmane.org 1484684043 30770 195.159.176.226 (17 Jan 2017 20:14:03 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 17 Jan 2017 20:14:03 +0000 (UTC) User-Agent: Mutt/1.5.24 (2015-08-30) Cc: 25462@debbugs.gnu.org To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jan 17 21:13:58 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1cTa8b-0006sF-JI for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Jan 2017 21:13:49 +0100 Original-Received: from localhost ([::1]:37475 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cTa8g-0006OQ-FR for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Jan 2017 15:13:54 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33202) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cTa7v-000624-5j for bug-gnu-emacs@gnu.org; Tue, 17 Jan 2017 15:13:09 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cTa7q-0002UQ-3Q for bug-gnu-emacs@gnu.org; Tue, 17 Jan 2017 15:13:07 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:35872) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cTa7q-0002UG-0c for bug-gnu-emacs@gnu.org; Tue, 17 Jan 2017 15:13:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cTa7p-0000MS-SL for bug-gnu-emacs@gnu.org; Tue, 17 Jan 2017 15:13:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Alan Mackenzie Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 17 Jan 2017 20:13:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 25462 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 25462-submit@debbugs.gnu.org id=B25462.14846839611358 (code B ref 25462); Tue, 17 Jan 2017 20:13:01 +0000 Original-Received: (at 25462) by debbugs.gnu.org; 17 Jan 2017 20:12:41 +0000 Original-Received: from localhost ([127.0.0.1]:34071 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cTa7T-0000Lo-FQ for submit@debbugs.gnu.org; Tue, 17 Jan 2017 15:12:39 -0500 Original-Received: from ocolin.muc.de ([193.149.48.4]:53382 helo=mail.muc.de) by debbugs.gnu.org with smtp (Exim 4.84_2) (envelope-from ) id 1cTa7Q-0000Le-9r for 25462@debbugs.gnu.org; Tue, 17 Jan 2017 15:12:36 -0500 Original-Received: (qmail 1860 invoked by uid 3782); 17 Jan 2017 20:05:54 -0000 Original-Received: from acm.muc.de (p548C72E2.dip0.t-ipconnect.de [84.140.114.226]) by colin.muc.de (tmda-ofmipd) with ESMTP; Tue, 17 Jan 2017 21:05:53 +0100 Original-Received: (qmail 4745 invoked by uid 1000); 17 Jan 2017 20:05:39 -0000 Content-Disposition: inline In-Reply-To: X-Delivery-Agent: TMDA/1.1.12 (Macallan) X-Primary-Address: acm@muc.de X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:128177 Archived-At: Hello, Noam. On Mon, Jan 16, 2017 at 04:52:36PM -0500, Noam Postavsky wrote: > On Mon, Jan 16, 2017 at 4:30 PM, Alan Mackenzie wrote: > > Hello, Emacs. > > The doc string for "`" has become partial. > > It fails to mention that "`" has a radically different meaning when used > > in certain parts of a `pcase', and probably quite a few other similar > > macros. > I don't think that makes sense. Similarly, we don't add a mention of > `cl-loop's use of `if' in the docstring of `if', because that's not > part of the `if' special form. It's just a use of `if' as a plain > symbol. I don't think `if' inside cl-loop is liable to cause much confusion. pcase, on the other hand, does cause confusion, as it radically changes the meaning of symbols contained within it, something that other macros don't do - with the possible minor exception of cl-loop. If you can think of any other such examples of context dependence changing the semantics, I think these should be documented too. The direction I'm coming from is to make the doc strings help users - not to make them 100% consistent. -- Alan Mackenzie (Nuremberg, Germany).