From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Robert Pluim Newsgroups: gmane.emacs.devel Subject: Re: Quoting t and nil in docstrings Date: Thu, 07 Feb 2019 14:30:16 +0100 Message-ID: References: <20190207085733.4723.6852@vcs0.savannah.gnu.org> <20190207085734.B17CF2047A@vcs0.savannah.gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="184383"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Aurelien Aptel , emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Feb 07 14:30: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 1grjlF-000lp0-14 for ged-emacs-devel@m.gmane.org; Thu, 07 Feb 2019 14:30:37 +0100 Original-Received: from localhost ([127.0.0.1]:40100 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1grjlD-0005oM-UP for ged-emacs-devel@m.gmane.org; Thu, 07 Feb 2019 08:30:35 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:50968) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1grjl0-0005nB-HG for emacs-devel@gnu.org; Thu, 07 Feb 2019 08:30:23 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1grjkz-0007ES-PE for emacs-devel@gnu.org; Thu, 07 Feb 2019 08:30:22 -0500 Original-Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:40129) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1grjkz-0007Dl-Hs for emacs-devel@gnu.org; Thu, 07 Feb 2019 08:30:21 -0500 Original-Received: by mail-wr1-x429.google.com with SMTP id q1so1564499wrp.7 for ; Thu, 07 Feb 2019 05:30:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:mail-followup-to:mail-copies-to :gmane-reply-to-list:date:in-reply-to:message-id:mime-version; bh=Vb5s5ELYW6ikuF+YDtJSvXJHQudD0IMmB1JMT8hZfF0=; b=g4hc0Kw4RUygX7wwoow9WDVcpGcYreum6ZOtJsH4w5KGj6IOkTRkodZj2/Laxw7lk3 0kNrNX3/RnpkMkE1ayl6gCNaOWV/b2lqgr2xtMD0eJ+C1R/0sZLDt92c0pYTGdQYerX+ h1yOomIp3VH+mLRvYqlL/8FJl8T4bP5eWZLuuOwJSlfQNTx06UYuJNFPpTQiN/Djp6rU iihBoVdQNTlT7kiQiVRD8JwuZYsDX7dCrvvLLaO2NEmO9oz21P4dPK2up51DSwh0rnvm P+Z62SBYIaX9dykEdJplnMZUjLarMlyChCgteKZSs5YpmLsXSYFV5dw6HZY1wclnGxqo oxTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:mail-followup-to :mail-copies-to:gmane-reply-to-list:date:in-reply-to:message-id :mime-version; bh=Vb5s5ELYW6ikuF+YDtJSvXJHQudD0IMmB1JMT8hZfF0=; b=kcKkEKOVWRnQJYVcURv9PStPqicUW2T5oGuMGAXCYsntVxLhnFH/Xj4X1gwY4MSUh7 U56GK+VN19U4Hzc819kOrc+KzGrk26exxxq28Os0ihUqEbYprQ8xG9KWTqblOZed0dYe SoBSd55qA1/QJP4q5hxFjydfuw/spYzwI9rI1WkEHRCeObGM2o6QwVeKx+o2bfe3t4CG w3Aws39xjDK6PbU/4UhIf1ODY9UYxzmKJq314szAsdp88eQMbntkeifJ7QDnnpv3VZO9 BvQKAHXbBSe/gW3ihV9gZ6QJsHplSZVA6h123cujyy/U/5zJBfWcrtLZZhTKx46goFo5 eDVA== X-Gm-Message-State: AHQUAuZWZ9vUCKYXooPN36zI/YRRCumdLu7Vu3k5qFsZ260LSgvxjvWA GNBsIBeN5Fi4UO62C2oQlHk= X-Google-Smtp-Source: AHgI3IZy2cpyw36/m03guz9g3ItIosFea3vYho4jNgh/cPI6R5lfS1qlImKS4nvkLDsy/OqO+tMWjQ== X-Received: by 2002:adf:e2c5:: with SMTP id d5mr9177451wrj.50.1549546219536; Thu, 07 Feb 2019 05:30:19 -0800 (PST) Original-Received: from rpluim-mac ([149.5.228.1]) by smtp.gmail.com with ESMTPSA id h1sm12544625wmb.0.2019.02.07.05.30.17 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Thu, 07 Feb 2019 05:30:17 -0800 (PST) Mail-Followup-To: emacs-devel@gnu.org Mail-Copies-To: never Gmane-Reply-To-List: yes In-Reply-To: (Stefan Monnier's message of "Thu, 07 Feb 2019 08:12:04 -0500") X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::429 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:233082 Archived-At: Stefan Monnier writes: >> 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 > > 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 > `...'. > > FWIW, I don't find this exception to be beneficial here, nor in cases > like: > > `foo' means ... > `bar' means ... > nil means ... > t means ... > > Or when a sentence starts with "nil" (where the lack of capital letter > looks like a typo). > > 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. Aren't you supposed to say @code{t} in texinfo? That seems inconsistent with not quoting in docstrings. Robert