From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: Quoting t and nil in docstrings (was: [Emacs-diffs] master b952385: Revert "Fix typo in add-hook doc string") Date: Thu, 7 Feb 2019 06:52:10 -0800 (PST) Message-ID: <3786817e-806c-46ea-9af8-9bd95b8aad01@default> References: <20190207085733.4723.6852@vcs0.savannah.gnu.org> <20190207085734.B17CF2047A@vcs0.savannah.gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="103287"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Aurelien Aptel To: Stefan Monnier , emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Feb 07 15:54:37 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1grl4W-000Qk7-VY for ged-emacs-devel@m.gmane.org; Thu, 07 Feb 2019 15:54:37 +0100 Original-Received: from localhost ([127.0.0.1]:41475 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1grl4V-0000Dh-TZ for ged-emacs-devel@m.gmane.org; Thu, 07 Feb 2019 09:54:35 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:42282) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1grl2F-0006tb-AC for emacs-devel@gnu.org; Thu, 07 Feb 2019 09:52:16 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1grl2E-0005YH-GD for emacs-devel@gnu.org; Thu, 07 Feb 2019 09:52:15 -0500 Original-Received: from userp2130.oracle.com ([156.151.31.86]:44584) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1grl2E-0005Xl-85 for emacs-devel@gnu.org; Thu, 07 Feb 2019 09:52:14 -0500 Original-Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x17En1Hf195528; Thu, 7 Feb 2019 14:52:13 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=tIf0fCfzZ/+C8cXTQ7guiN4NuyN/MsK11eKINcDauAs=; b=qlsgKIc5FMrhmXSx5v3FIMyglko00PSaKA8Uk94n/81d7f9+zutGTCA1qcxiq5CtrKv6 4V4lwT9RP9wQop37S6F5+TCYnLpxNyyJ/SERuY+Xz+UYkPIx839ohzavsa4nLXLeGYC8 m+SY4zX8frQs1ybGMFtiOdrcHkVGZRXKwAoSwcsmn+diyX/hQt76lUd+MHBFHXtf/SB2 wWFmrzIVCI/UBxg6dEcHCl76KBn9tO8oSpPU0S03n8FbVwEBct+FFuBn8FfeCgRVkvdr 0BgnvQ8/P8zw0XGrHkn0SOZ7BW+PWucR9NLH/c6pPfJjEJ4NlkuI5AYItEGNa2uwDfUP 1A== Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp2130.oracle.com with ESMTP id 2qd9arqb6d-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 07 Feb 2019 14:52:13 +0000 Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id x17EqCvb031636 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 7 Feb 2019 14:52:12 GMT Original-Received: from abhmp0012.oracle.com (abhmp0012.oracle.com [141.146.116.18]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id x17EqBDF031153; Thu, 7 Feb 2019 14:52:12 GMT In-Reply-To: X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4795.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9159 signatures=668682 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1011 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1902070114 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] X-Received-From: 156.151.31.86 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:233088 Archived-At: > > Revert "Fix typo in add-hook doc string" > [...] > > -This makes the hook buffer-local, and it makes it a member of the > > +This makes the hook buffer-local, and it makes t a member of the >=20 > This is as good an opportunity as any to question our long-standing > convention that the symbols `nil` and `t` are treated specially in > docstrings in the sense that we don't surround them with the customary > `...'. >=20 > FWIW, I don't find this exception to be beneficial here, nor in cases > like: >=20 > `foo' means ... > `bar' means ... > nil means ... > t means ... >=20 > Or when a sentence starts with "nil" (where the lack of capital letter > looks like a typo). >=20 > I think we could at least change our convention to say that nil and > t don't have to be quoted rather than to say that they should not > be quoted. +1 The (new) convention could be discretionary. There are likely some contexts where it is not necessary (but it wouldn't hurt).