[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: In docstrings: `sym' and ‘sym’ are equivalent to mismatched `sym’ an

From: Paul Eggert
Subject: Re: In docstrings: `sym' and ‘sym’ are equivalent to mismatched `sym’ and ‘sym' (and ‘'sym’, nor `undefined' cannot be used)
Date: Thu, 18 Oct 2018 08:01:04 -0700
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.2.1

On 10/18/18 7:07 AM, Garreau, Alexandre wrote:
I noticed it while trying this:

#+BEGIN_SRC emacs-lisp
(defcustom gnus-build-sparse-threads nil
   "*If non-nil, fill in the gaps in threads.
If “'some”, only fill in the gaps that are needed to tie loose threads
together.  If ‘'more’, fill in all leaf nodes that Gnus can find.  If
non-nil and non-‘some’, fill in all gaps that Gnus manages to guess."

As Clément wrote, you could use `\\='more' if you want the curled version to look like ‘'more’. However, the curled version shouldn't look like that. It should look like ‘more’ without the apostrophe. Doc strings should talk about the values in question, not about code that would yield those values.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]