GNU bug report logs - #43205
28.0.50; Eldoc protocol not useful for third-party packages

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 43205 in the body.
You can then email your comments to 43205 AT debbugs.gnu.org in the normal way.

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

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

From: Yuan Fu <casouri <at> gmail.com>
To: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>
Subject: 28.0.50; Eldoc protocol not useful for third-party packages
Date: Fri, 4 Sep 2020 12:13:10 -0400

Currently the documentation of `eldoc-documentation-functions' says this:

* `:thing', VALUE is a short string or symbol designating what is
being reported on.  The documentation display engine can elect
to remove this information depending on space contraints;

without saying what VALUE could be. For someone who want to write a
frontend to display eldoc signitures, this is useless. For someone who
want to write a documentation backend for eldoc, this is useless as
well. I think the protocol should at least specify what VALUE could be
expected: signature? full-doc? example? links?



Also contraints is spelled wrong. And on line 705.

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

From: João Távora <joaotavora <at> gmail.com>
To: Yuan Fu <casouri <at> gmail.com>
Cc: 43205 <at> debbugs.gnu.org
Subject: Re: bug#43205: 28.0.50;
 Eldoc protocol not useful for third-party packages
Date: Fri, 4 Sep 2020 19:32:30 +0100

[Message part 1 (text/plain, inline)]

Acknowledged. The latest eldoc in master is a work in progress.This in on
my to-do list. Soon I'll improve the documentation, as well as specifying
what the "display engine" is supposed to be.

I think, this will be quite useful when (re) designing your eldoc-box
extension, Yuan. Maybe that extension could even be included into Emacs
itself.

João

On Fri, Sep 4, 2020, 17:18 Yuan Fu <casouri <at> gmail.com> wrote:

> Currently the documentation of `eldoc-documentation-functions' says this:
>
> * `:thing', VALUE is a short string or symbol designating what is
> being reported on.  The documentation display engine can elect
> to remove this information depending on space contraints;
>
> without saying what VALUE could be. For someone who want to write a
> frontend to display eldoc signitures, this is useless. For someone who
> want to write a documentation backend for eldoc, this is useless as
> well. I think the protocol should at least specify what VALUE could be
> expected: signature? full-doc? example? links?
>
>
>
> Also contraints is spelled wrong. And on line 705.
>
>
>
>

[Message part 2 (text/html, inline)]

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

From: Yuan Fu <casouri <at> gmail.com>
To: João Távora <joaotavora <at> gmail.com>
Cc: 43205 <at> debbugs.gnu.org
Subject: Re: bug#43205: 28.0.50; Eldoc protocol not useful for third-party
 packages
Date: Fri, 4 Sep 2020 15:03:24 -0400

> On Sep 4, 2020, at 2:32 PM, João Távora <joaotavora <at> gmail.com> wrote:
> 
> Acknowledged. The latest eldoc in master is a work in progress.This in on my to-do list. Soon I'll improve the documentation, as well as specifying what the "display engine" is supposed to be.
> 
> I think, this will be quite useful when (re) designing your eldoc-box extension, Yuan. Maybe that extension could even be included into Emacs itself.

Indeed, I’m looking at the new eldoc to see if I can remove some unnecessary complications introduced by the incompetence of the old protocol. Thanks for working on this.

Yuan

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Yuan Fu <casouri <at> gmail.com>
Cc: 43205 <at> debbugs.gnu.org
Subject: Re: bug#43205: 28.0.50; Eldoc protocol not useful for third-party
 packages
Date: Sat, 12 Jun 2021 14:31:53 +0200

Yuan Fu <casouri <at> gmail.com> writes:

> Currently the documentation of `eldoc-documentation-functions' says this:
>
> * `:thing', VALUE is a short string or symbol designating what is
> being reported on.  The documentation display engine can elect
> to remove this information depending on space contraints;
>
> without saying what VALUE could be. 

It looks like this was fixed in

commit 4c543a724f2caff41d97a323bd4fffe3e86e8471
Author:     João Távora <joaotavora <at> gmail.com>
AuthorDate: Sun Sep 6 15:37:02 2020 +0100

so I'm closing this bug report.  If there's still improvements that
should be made here, please respond to the debbugs address and we'll
reopen.

-- 
(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.