* bug#31063: 27.0.50; improve help for advised functions
@ 2018-04-04 18:43 Charles A. Roelli
2019-07-13 15:50 ` Lars Ingebrigtsen
0 siblings, 1 reply; 6+ messages in thread
From: Charles A. Roelli @ 2018-04-04 18:43 UTC (permalink / raw)
To: 31063
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?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#31063: 27.0.50; improve help for advised functions
2018-04-04 18:43 bug#31063: 27.0.50; improve help for advised functions Charles A. Roelli
@ 2019-07-13 15:50 ` Lars Ingebrigtsen
2019-07-14 19:55 ` Juri Linkov
0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-07-13 15:50 UTC (permalink / raw)
To: Charles A. Roelli; +Cc: 31063
charles@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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#31063: 27.0.50; improve help for advised functions
2019-07-13 15:50 ` Lars Ingebrigtsen
@ 2019-07-14 19:55 ` Juri Linkov
2019-07-14 20:07 ` Lars Ingebrigtsen
0 siblings, 1 reply; 6+ messages in thread
From: Juri Linkov @ 2019-07-14 19:55 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: Charles A. Roelli, 31063
>> 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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#31063: 27.0.50; improve help for advised functions
2019-07-14 19:55 ` Juri Linkov
@ 2019-07-14 20:07 ` Lars Ingebrigtsen
2019-07-14 20:55 ` Juri Linkov
0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-07-14 20:07 UTC (permalink / raw)
To: Juri Linkov; +Cc: Charles A. Roelli, 31063
Juri Linkov <juri@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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#31063: 27.0.50; improve help for advised functions
2019-07-14 20:07 ` Lars Ingebrigtsen
@ 2019-07-14 20:55 ` Juri Linkov
2019-07-15 10:12 ` Lars Ingebrigtsen
0 siblings, 1 reply; 6+ messages in thread
From: Juri Linkov @ 2019-07-14 20:55 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: Charles A. Roelli, 31063
>>>>> (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'?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#31063: 27.0.50; improve help for advised functions
2019-07-14 20:55 ` Juri Linkov
@ 2019-07-15 10:12 ` Lars Ingebrigtsen
0 siblings, 0 replies; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-07-15 10:12 UTC (permalink / raw)
To: Juri Linkov; +Cc: Charles A. Roelli, 31063
Juri Linkov <juri@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
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-07-15 10:12 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-04 18:43 bug#31063: 27.0.50; improve help for advised functions Charles A. Roelli
2019-07-13 15:50 ` Lars Ingebrigtsen
2019-07-14 19:55 ` Juri Linkov
2019-07-14 20:07 ` Lars Ingebrigtsen
2019-07-14 20:55 ` Juri Linkov
2019-07-15 10:12 ` Lars Ingebrigtsen
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).