[Top][All Lists]

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

Re: [PROPOSED-PATCH] Fix doc string quoting problems with '

From: Paul Eggert
Subject: Re: [PROPOSED-PATCH] Fix doc string quoting problems with '
Date: Mon, 25 Jul 2022 13:14:09 -0700
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0

On 7/25/22 01:50, Ihor Radchenko wrote:

The conventions sound reasonable, though I do not think that they are
documented in D.6 Tips for Documentation Strings section of the Elisp

Thanks, I added the following to the Elisp manual to try to fix that:


I am not sure if it is a
good idea to change explicit 'symbol or '(...) mentions in the
documentation of the defcustoms. In particular, when 'symbol is intended
to be set as (setq variable 'symbol), I feel that 'symbol should be
preferred over `symbol' - it will make life easier for users who can
then just copy-paste the text from docstring.

OK, I went with a more conservative route there, e.g., replacing this:

  \\='((?R set-category get-category))

with this:

(setq org-agenda-bulk-custom-functions \\='((?R set-category get-category)))

Although wordier, this follows the doc string guidelines and should make it clear why the apostrophe is present.

Also, note that references in the babel documentation are _not_ Elisp
symbols - they are defined in #+name: name lines at the relevant src

Yes, I left those alone. Here's what I installed:


reply via email to

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