From: Lars Ingebrigtsen <larsi@gnus.org>
To: Eliza Velasquez <eliza@eliza.sh>
Cc: 55780@debbugs.gnu.org
Subject: bug#55780: 29.0.50; byte-compile-docstring-style-warn warns against valid usages of curved quotes
Date: Fri, 03 Jun 2022 13:08:19 +0200 [thread overview]
Message-ID: <87y1ye9f8c.fsf@gnus.org> (raw)
In-Reply-To: <87h752d33a.fsf@eliza.sh> (Eliza Velasquez's message of "Thu, 02 Jun 2022 17:04:41 -0700")
Eliza Velasquez <eliza@eliza.sh> writes:
> The elisp manual states in "(elisp)Documentation Tips"
>
>> When a documentation string refers to a Lisp symbol, write it as it
>> would be printed (which usually means in lower case), surrounding it
>> with curved single quotes (‘..’).
>
> ‘checkdoc’ treats this case as valid.
>
> Recently, though, it seems like bytecomp.el’s
> ‘byte-compile-docstring-style-warn’ function was recently modified by
> 2701cd59b521989530a7eb7489540c64177e0f69 which mistakenly flags this
> usage as incorrect.
The ‘..’ convention in doc strings was introduced in 2015, but never
really took off -- even after seven years, there were only a dozen
usages in-tree, so it seemed time to revert back to the previous
convention (which is to use `...', which is then converted to ‘...’ on
display). The problem with ‘..’ is that nobody still knows how to type
it, and if you're working on a display that can't display those
characters, the help texts are all messed up. (Which isn't the case
when using `...'.)
I forgot to update the documentation here, though, so I've now done
that. Perhaps it's a bit early to issue a compilation warning for this,
though, since it's probably found in the wild here and there, so I've
now disabled that in Emacs 29.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2022-06-03 11:08 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-03 0:04 bug#55780: 29.0.50; byte-compile-docstring-style-warn warns against valid usages of curved quotes Eliza Velasquez
2022-06-03 11:08 ` Lars Ingebrigtsen [this message]
2022-06-04 1:32 ` Eliza Velasquez
2022-06-04 11:30 ` Lars Ingebrigtsen
2022-06-04 12:21 ` Andreas Röhler
2022-06-04 13:15 ` Lars Ingebrigtsen
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87y1ye9f8c.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=55780@debbugs.gnu.org \
--cc=eliza@eliza.sh \
/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.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).