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

[Paul Eggert]

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
> manual.

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

https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=d04701c0c4959d3c42587a4e1277bb517a2ea04b


> 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
> blocks.

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

https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=6013cb161d6f186829f6bfcfc5dd927c6cb89b49