From: "Mattias Engdegård" <mattias.engdegard@gmail.com>
To: Chen Zhaoyang <chenzhauyang@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: Escape syntax in docstrings
Date: Fri, 24 Mar 2023 14:22:04 +0100 [thread overview]
Message-ID: <3143D454-E439-44B8-82DA-CBC5D1B455F2@gmail.com> (raw)
In-Reply-To: <877cv7nlnr.fsf@gmail.com>
23 mars 2023 kl. 23.32 skrev Chen Zhaoyang <chenzhauyang@gmail.com>:
> I totally did not know about the fact that "\x" means NUL in docstrings.
Most likely even the original author of that code in the Lisp reader did totally not know about that.
> I do agree that using the slash to represent λ in docstring is not so
> good to begin with.
There is always a tension in doc strings between their dual roles as comments to be read in the source, and as strings to be displayed in help text. Text mark-up in doc strings and comments adds an extra layer to the problem.
The best we can do is trying to catch mistakes as early as possible.
>> Good catch. Would you tell the Agdas about it?
>
> Yeah, I am grepping for cases like this and will submit a patch to them soon.
Excellent. There is now a special \x check in relint as well.
next prev parent reply other threads:[~2023-03-24 13:22 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-23 22:32 Escape syntax in docstrings Chen Zhaoyang
2023-03-24 13:22 ` Mattias Engdegård [this message]
2023-03-24 15:58 ` David Ongaro
2023-03-24 17:22 ` Chen Zhaoyang
-- strict thread matches above, loose matches on Subject: below --
2023-03-23 20:46 Chen Zhaoyang
2023-03-23 22:02 ` Mattias Engdegård
2023-03-24 16:17 ` James Cloos
2023-03-24 21:17 ` Philip Kaludercic
2023-03-28 12:14 ` Robert Pluim
2023-03-28 12:27 ` Andreas Schwab
2023-03-28 15:23 ` Robert Pluim
2023-03-24 4:04 ` Ruijie Yu via Emacs development discussions.
2023-03-24 4:44 ` Chen Zhaoyang
2023-03-24 18:29 ` Eli Zaretskii
2023-03-24 19:58 ` Chen Zhaoyang
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=3143D454-E439-44B8-82DA-CBC5D1B455F2@gmail.com \
--to=mattias.engdegard@gmail.com \
--cc=chenzhauyang@gmail.com \
--cc=emacs-devel@gnu.org \
/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).