From: Paul Eggert <eggert@cs.ucla.edu>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PROPOSED-PATCH] Fix doc string quoting problems with '
Date: Mon, 25 Jul 2022 13:14:09 -0700 [thread overview]
Message-ID: <a885fa60-3c7f-2e8c-fe80-bdfbaa62183c@cs.ucla.edu> (raw)
In-Reply-To: <87k081vams.fsf@localhost>
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
prev parent reply other threads:[~2022-07-25 20:15 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-24 17:07 [PROPOSED-PATCH] Fix doc string quoting problems with ' Paul Eggert
2022-07-25 8:50 ` Ihor Radchenko
2022-07-25 20:14 ` Paul Eggert [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a885fa60-3c7f-2e8c-fe80-bdfbaa62183c@cs.ucla.edu \
--to=eggert@cs.ucla.edu \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).