GNU bug report logs - #21299
describe-function on advised autoloads

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 21299 in the body.
You can then email your comments to 21299 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Glenn Morris <rgm <at> gnu.org>
To: submit <at> debbugs.gnu.org
Subject: describe-function on advised autoloads
Date: Thu, 20 Aug 2015 13:39:18 -0400

Package: emacs
Version: 25.0.50

A couple of issues related to describe-function on advised autoloads.
Current master, emacs -Q.

1) When the autoload has known arguments:

(autoload 'foo1 "foo" "Do something.

\(fn arg1)")

(defun foo-ad (&rest _args))

(advice-add 'foo1 :before #'foo-ad)

C-h f foo1
 ->  foo1 is an alias for 'foo1'

Informative!

Also, the fact that foo1 has advice is not mentioned.


2) When the function has unknown arguments:

(autoload 'foo2 "foo" "Do something.")
(advice-add 'foo2 :before #'foo-ad)

C-h f foo2
 -> foo2 is an alias for 'foo2'

 (foo2 91 65 114 103 32 108 105 115 116 32 110 111 116 32 97 118 97 105
 108 97 98 108 101 32 117 110 116 105 108 32 102 117 110 99 116 105 111
 110 32 100 101 102 105 110 105 116 105 111 110 32 105 115 32 108 111
 97 100 101 100 46 93)

 Do something.

Nice argument list...

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

From: Glenn Morris <rgm <at> gnu.org>
To: 21299 <at> debbugs.gnu.org
Subject: Re: bug#21299: describe-function on advised autoloads
Date: Mon, 13 Jun 2016 18:19:44 -0400

The only remaining issue is now:

> the fact that foo1 has advice is not mentioned.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 23523 <at> debbugs.gnu.org, 21299 <at> debbugs.gnu.org
Subject: Re: bug#21299: describe-function on advised autoloads
Date: Fri, 03 Sep 2021 13:49:34 +0200

Kaushal Modi <kaushal.modi <at> gmail.com> writes:

> Here's a short elisp snippet to try in an emacs -Q session:
>
> =====
> (defun foo (orig-fun &rest args)
>   (apply orig-fun args))
> (advice-add 'report-emacs-bug :around #'foo)
> (advice-add 'pop-to-mark-command :around #'foo)
> =====
>
> After evaluating the above, if I do C-h f report-emacs-bug, I get:
>
> =====
> report-emacs-bug is an alias for ‘report-emacs-bug’ in ‘emacsbug.el’.
>
> It is bound to <menu-bar> <help-menu> <send-emacs-bug-report>.
>
> (report-emacs-bug TOPIC &optional UNUSED)
>
> Report a bug in GNU Emacs.
> Prompts for bug subject.  Leaves you in a mail buffer.

This is now fixed in Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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