* bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages
@ 2020-09-04 16:13 Yuan Fu
2020-09-04 18:32 ` João Távora
2021-06-12 12:31 ` Lars Ingebrigtsen
0 siblings, 2 replies; 4+ messages in thread
From: Yuan Fu @ 2020-09-04 16:13 UTC (permalink / raw)
To: 43205
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.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages
2020-09-04 16:13 bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages Yuan Fu
@ 2020-09-04 18:32 ` João Távora
2020-09-04 19:03 ` Yuan Fu
2021-06-12 12:31 ` Lars Ingebrigtsen
1 sibling, 1 reply; 4+ messages in thread
From: João Távora @ 2020-09-04 18:32 UTC (permalink / raw)
To: Yuan Fu; +Cc: 43205
[-- 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 --]
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages
2020-09-04 18:32 ` João Távora
@ 2020-09-04 19:03 ` Yuan Fu
0 siblings, 0 replies; 4+ messages in thread
From: Yuan Fu @ 2020-09-04 19:03 UTC (permalink / raw)
To: João Távora; +Cc: 43205
> 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
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages
2020-09-04 16:13 bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages Yuan Fu
2020-09-04 18:32 ` João Távora
@ 2021-06-12 12:31 ` Lars Ingebrigtsen
1 sibling, 0 replies; 4+ messages in thread
From: Lars Ingebrigtsen @ 2021-06-12 12:31 UTC (permalink / raw)
To: Yuan Fu; +Cc: 43205
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-06-12 12:31 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-04 16:13 bug#43205: 28.0.50; Eldoc protocol not useful for third-party packages Yuan Fu
2020-09-04 18:32 ` João Távora
2020-09-04 19:03 ` Yuan Fu
2021-06-12 12:31 ` 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).