GNU bug report logs - #77169
[PATCH] New Eldoc function `help-at-pt-eldoc-function'

Previous Next

Full log

View this message in rfc822 format

From: Daniel Mendler <mail <at> daniel-mendler.de>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 77169 <at> debbugs.gnu.org
Subject: bug#77169: [PATCH] New Eldoc function `help-at-pt-eldoc-function'
Date: Sat, 22 Mar 2025 12:29:13 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Sat, 22 Mar 2025 10:40:18 +0100
>> From:  Daniel Mendler via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> This patch proposes the addition of a new Eldoc function
>> `help-at-pt-eldoc-function'.
>> 
>> Show help-at-pt string via Eldoc as an alternative to the
>> `help-at-pt-display-when-idle' timer.  The help-at-pt timer competes
>> with Eldoc for the echo area, such that using both does not work well.
>> The new `help-at-pt-eldoc-function' is meant to be added to
>> `eldoc-documentation-functions'.

Eli, thank you for looking at the patch so quickly.

> Thanks, but please also reflect this feature in the doc string of
> help-at-pt-display-when-idle and in the Emacs user manual (where that
> option is described).

The question is if `help-at-pt-display-when-idle' should be marked
obsolete in favor of the Eldoc mechanism to avoid conflicts. Eldoc is
even preloaded these days, so the de-facto standard for documentation at
point.

> Also, shouldn't we have a user option to turn this on in ElDoc?

Not sure if we need an option given that it is easy to add the function
to the list, or remove it, if the function is enabled by default.

(add-hook 'eldoc-documentation-functions #'help-at-pt-eldoc-function)
(remove-hook 'eldoc-documentation-functions #'help-at-pt-eldoc-function)

> And what about a NEWS entry?

I will add one.

Daniel

Previous Next

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