GNU bug report logs - #50222
Advising a function pollutes its docstring

Previous Next

Package: emacs;

Reported by: Clément Pit-Claudel <clement.pitclaudel <at> live.com>

Date: Fri, 27 Aug 2021 03:31:02 UTC

Severity: normal

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log

Message #8 received at 50222 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Clément Pit-Claudel <clement.pitclaudel <at> live.com>
Cc: 50222 <at> debbugs.gnu.org
Subject: Re: bug#50222: Advising a function pollutes its docstring
Date: Fri, 27 Aug 2021 11:04:21 -0400

> Advising a function changes the first line of its docstring, which
> breaks packages that use the first line of the docstring to display
> a short piece of information about a function.  I noticed this issue
> while playing with the "shortdoc" feature. For example:

Indeed, we should probably use `help-fns-describe-function-functions`
instead of the `function-documentation` property in `nadvice.el`.


        Stefan
This bug report was last modified 3 years and 327 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.