bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages

bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages

[Yuan Fu]

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.

bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages

[João Távora]

[-- Attachment #1: Type: text/plain, Size: 1121 bytes --]

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

[-- Attachment #2: Type: text/html, Size: 1524 bytes --]

bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages

[Yuan Fu]

> On Sep 4, 2020, at 2:32 PM, João Távora <joaotavora@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

bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages

[Lars Ingebrigtsen]

Yuan Fu <casouri@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@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