[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Quoting t and nil in docstrings (was: [Emacs-diffs] master b952385:
From: |
Richard Stallman |
Subject: |
Re: Quoting t and nil in docstrings (was: [Emacs-diffs] master b952385: Revert "Fix typo in add-hook doc string") |
Date: |
Thu, 07 Feb 2019 22:19:41 -0500 |
[[[ To any NSA and FBI agents reading my email: please consider ]]]
[[[ whether defending the US Constitution against all enemies, ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]
> 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
> `...'.
I decided on that exception because generally it is convenient.
Symbols as fundamental as t and nil don't need markup.
> 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.
I would agree with saying it is ok to give them quotes in special cases
where that makes the text clearer.
--
Dr Richard Stallman
President, Free Software Foundation (https://gnu.org, https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)