GNU bug report logs -
#31063
27.0.50; improve help for advised functions
Previous Next
Reported by: charles <at> aurox.ch (Charles A. Roelli)
Date: Wed, 4 Apr 2018 18:43:01 UTC
Severity: wishlist
Tags: fixed
Found in version 27.0.50
Fixed in version 27.1
Done: Lars Ingebrigtsen <larsi <at> gnus.org>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 31063 in the body.
You can then email your comments to 31063 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Wed, 04 Apr 2018 18:43:01 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
charles <at> aurox.ch (Charles A. Roelli):
New bug report received and forwarded. Copy sent to
bug-gnu-emacs <at> gnu.org.
(Wed, 04 Apr 2018 18:43:02 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
Getting help on an advised function looks like this:
> eval-defun is an interactive compiled Lisp function in
> ‘elisp-mode.el’.
>
> (eval-defun EDEBUG-IT)
>
> :override advice: ‘edebug-eval-defun’
(where ":override advice:" is highlighted in orange)
Could we please remove (or amend) the orange color for readability,
make the indication of advice a full sentence, and possibly explain
the meaning of the different advices?
Information forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Sat, 13 Jul 2019 15:51:01 GMT)
Full text and
rfc822 format available.
Message #8 received at 31063 <at> debbugs.gnu.org (full text, mbox):
charles <at> aurox.ch (Charles A. Roelli) writes:
> Getting help on an advised function looks like this:
>
>> eval-defun is an interactive compiled Lisp function in
>> ‘elisp-mode.el’.
>>
>> (eval-defun EDEBUG-IT)
>>
>> :override advice: ‘edebug-eval-defun’
>
> (where ":override advice:" is highlighted in orange)
>
> Could we please remove (or amend) the orange color for readability,
> make the indication of advice a full sentence, and possibly explain
> the meaning of the different advices?
I've now made it into a complete sentence on the Emacs trunk. I think
it's probably beyond the scope of the doc function to explain what the
advices mean in detail...
I also removed the warning face, but feel free to put that back if
somebody thinks that this deserves a warning. It seemed a bit too
dramatic to me.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) fixed.
Request was from
Lars Ingebrigtsen <larsi <at> gnus.org>
to
control <at> debbugs.gnu.org.
(Sat, 13 Jul 2019 15:51:02 GMT)
Full text and
rfc822 format available.
bug marked as fixed in version 27.1, send any further explanations to
31063 <at> debbugs.gnu.org and charles <at> aurox.ch (Charles A. Roelli)
Request was from
Lars Ingebrigtsen <larsi <at> gnus.org>
to
control <at> debbugs.gnu.org.
(Sat, 13 Jul 2019 15:51:03 GMT)
Full text and
rfc822 format available.
Information forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Sun, 14 Jul 2019 20:03:02 GMT)
Full text and
rfc822 format available.
Message #15 received at 31063 <at> debbugs.gnu.org (full text, mbox):
>> Getting help on an advised function looks like this:
>>
>>> eval-defun is an interactive compiled Lisp function in
>>> ‘elisp-mode.el’.
>>>
>>> (eval-defun EDEBUG-IT)
>>>
>>> :override advice: ‘edebug-eval-defun’
>>
>> (where ":override advice:" is highlighted in orange)
>>
>> Could we please remove (or amend) the orange color for readability,
>
> I also removed the warning face, but feel free to put that back if
> somebody thinks that this deserves a warning. It seemed a bit too
> dramatic to me.
It could have a link on ":override advice:" clicking on which will
visit the advice definition.
Information forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Sun, 14 Jul 2019 20:08:02 GMT)
Full text and
rfc822 format available.
Message #18 received at 31063 <at> debbugs.gnu.org (full text, mbox):
Juri Linkov <juri <at> linkov.net> writes:
>>>> (eval-defun EDEBUG-IT)
>>>>
>>>> :override advice: ‘edebug-eval-defun’
>>>
>>> (where ":override advice:" is highlighted in orange)
>>>
>>> Could we please remove (or amend) the orange color for readability,
>>
>> I also removed the warning face, but feel free to put that back if
>> somebody thinks that this deserves a warning. It seemed a bit too
>> dramatic to me.
>
> It could have a link on ":override advice:" clicking on which will
> visit the advice definition.
That would be nice. Do we have that information?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
Information forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Sun, 14 Jul 2019 20:58:01 GMT)
Full text and
rfc822 format available.
Message #21 received at 31063 <at> debbugs.gnu.org (full text, mbox):
>>>>> (eval-defun EDEBUG-IT)
>>>>>
>>>>> :override advice: ‘edebug-eval-defun’
>>>>
>>>> (where ":override advice:" is highlighted in orange)
>>>>
>>>> Could we please remove (or amend) the orange color for readability,
>>>
>>> I also removed the warning face, but feel free to put that back if
>>> somebody thinks that this deserves a warning. It seemed a bit too
>>> dramatic to me.
>>
>> It could have a link on ":override advice:" clicking on which will
>> visit the advice definition.
>
> That would be nice. Do we have that information?
I remember that old defadvice had some link in the Help buffer, but
now I can't confirm this. But for new nadvice maybe this will work:
if a piece of advice is at least a function defined by `defun' then
maybe it's possible to display the body of advice with a link to the
function defined by `defun'?
Information forwarded
to
bug-gnu-emacs <at> gnu.org:
bug#31063; Package
emacs.
(Mon, 15 Jul 2019 10:13:02 GMT)
Full text and
rfc822 format available.
Message #24 received at 31063 <at> debbugs.gnu.org (full text, mbox):
Juri Linkov <juri <at> linkov.net> writes:
>>>>>> (eval-defun EDEBUG-IT)
>>>>>>
>>>>>> :override advice: ‘edebug-eval-defun’
>>>>>
>>>>> (where ":override advice:" is highlighted in orange)
>>>>>
>>>>> Could we please remove (or amend) the orange color for readability,
>>>>
>>>> I also removed the warning face, but feel free to put that back if
>>>> somebody thinks that this deserves a warning. It seemed a bit too
>>>> dramatic to me.
>>>
>>> It could have a link on ":override advice:" clicking on which will
>>> visit the advice definition.
>>
>> That would be nice. Do we have that information?
>
> I remember that old defadvice had some link in the Help buffer, but
> now I can't confirm this. But for new nadvice maybe this will work:
> if a piece of advice is at least a function defined by `defun' then
> maybe it's possible to display the body of advice with a link to the
> function defined by `defun'?
Hm... isn't that what that `edebug-eval-defun' thing up there is,
though?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org.
(Mon, 12 Aug 2019 11:24:08 GMT)
Full text and
rfc822 format available.
This bug report was last modified 4 years and 257 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.