From: Jens Schmidt via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 66032@debbugs.gnu.org, drew.adams@oracle.com
Subject: bug#66032: [PATCH] Inline advice documentation into advised function's docstring, after all
Date: Sat, 16 Sep 2023 19:15:27 +0200 [thread overview]
Message-ID: <87led6ghu8.fsf@sappc2.fritz.box> (raw)
In-Reply-To: <jwvbke2tc3k.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Sat, 16 Sep 2023 11:13:30 -0400")
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> But at least on one occasion Stefan has asked for a patch, and I
>> haven't seen yet patches that got declined.
>
> It does happen, tho.
From your detailed comments (thanks for those) I understand that a patch
for *this* bug would be, in principle, still welcome.
I'll re-comment only where I think it's needed, everything else I try to
implement as you seem to suggest.
> I got used to the single line where I have to click to get more info,
> so I'm not the target audience, but see comments below.
My advices' docstrings all start with verb in 3rd person singular, and
that looks awful if viewed standalone. (Showing off my standard
adherence here.) More seriously, I have been thinking about a
customizable option to control the inclusion of advice docstrings, but
nadvice.el seems to be too infrastructure-y for that.
> The main problem I see, tho, is how to clearly "delimit" the
> docstring. Maybe we should indent the advice's docstring by two
> spaces or so?
Probably OK, but I'm afraid that lines get too long, then. OTOH, advice
docstrings are probably not that lengthy, in general. I'll give it a
try and consider alternatives as well.
Do you think this docstring generation should be covered by ERT tests?
next prev parent reply other threads:[~2023-09-16 17:15 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-16 12:57 bug#66032: [PATCH] Inline advice documentation into advised function's docstring, after all Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 15:13 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 17:15 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-09-17 20:13 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-18 21:03 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-18 22:19 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-23 8:07 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-23 16:03 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-23 19:09 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-23 22:29 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
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=87led6ghu8.fsf@sappc2.fritz.box \
--to=bug-gnu-emacs@gnu.org \
--cc=66032@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=jschmidt4gnu@vodafonemail.de \
--cc=monnier@iro.umontreal.ca \
/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).