From: "João Távora" <joaotavora@gmail.com>
To: Yuan Fu <casouri@gmail.com>
Cc: 62029@debbugs.gnu.org
Subject: bug#62029: 29.0.60; Allow users to customize eldoc buffer separator
Date: Thu, 30 Mar 2023 09:13:56 +0100 [thread overview]
Message-ID: <87h6u2y7uj.fsf@gmail.com> (raw)
In-Reply-To: <FA7E2E3C-9BC2-455F-A9AE-391C5CE1D8F0@gmail.com> (Yuan Fu's message of "Wed, 29 Mar 2023 22:22:23 -0700")
Yuan Fu <casouri@gmail.com> writes:
>>>
>>> Looks good to me (except for the “documentatiok” ;-) eldoc-box can
>>> also benefit from this (right now if you use it in emacs-lisp-mode,
>>> it just shows a thin strip of text, not very exciting).
>>>
>>> I’ll experiment with the title thing in eldoc-box. Does eglot and
>>> flymake already pass a :source cookie? Those two displaying stuff
>>> together is the most possible case I can think of.
>>
>>
>>> it just shows a thin strip of text, not very exciting).
>>
>> Indeed. I'll present my patch soon in emacs-devel.
>> There's one thing I don't like about it which is that
>> is re-does a lot of complicated parsing for both *Help*
>> and *eldoc* forms. Could be slow, or could be meaningless.
>> Another aspect is that function documentation looks great
>> because there is this nifty describe-function-1 helper, but
>> variable documentation looks poor because there is
>> no such thing.
>
> Cool! The whole help system would benefit from some renovation, but I don’t think anyone is excited to do it ;-)
>
>>
>>> Does eglot and flymake already pass a :source cookie?
>>
>> You mean ':origin', not ':source'. Though the latter name is
>> acceptable and there's plently of time to change to it if you
>> think it's better or more consistent with other parts of Emacs.
>>
>> Yes they do. This cookie is automatic. Maybe I should state that
>> in the documentatiok.
>
> Yeah, I think it’ll be good to mentioned them in the documentatiok.
>
>>
>>> Those two displaying stuff together is the most possible case
>>> I can think of.
>>
>> In Eglot it's very usual to have three sources, and in Emacs
>> Lisp you can also have three (function, variable and flymake).
>>
>> You do need to set eldoc-documentation-strategy to
>> eldoc-documentation-compose though (this should really
>> be the default).
>
> Huh, I wonder why I can see both flymake + eglot in the eldoc doc
> buffer when my eldoc-documentation-strategy is the default value?
Because Eglot changes eldoc-documentation-strategy automatically. It
shouldn't but the default value is really bad.
The reason the default value is historic. Previously, there was a
single producer of ElDoc, and only in Emacs Lisp. It would decide
whether to show variable _or_ function doc, even if a given symbol had
more than one meaning. So what's the problem with setting
eldoc-documentation-strategy something like e-d-compose, you ask.
Well, because of the default value of eldoc-echo-area-use-multiline-p,
people would be seeing "bouncing" in the echo area while editing Elisp,
which is something they are not used to.
I think a very good solution is to set e-d-strategy to e-d-compose
globally and e-e-a-use-multiline-p to 1 in emacs-lisp-mode.
I once proposed this in this bug tracker, but the message was garbled by
some side discussion, and I gave up. And ElDoc wasn't so powerful then.
João
next prev parent reply other threads:[~2023-03-30 8:13 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-07 7:56 bug#62029: 29.0.60; Allow users to customize eldoc buffer separator Yuan Fu
2023-03-08 0:25 ` bug#62030: " Yuan Fu
2023-03-08 17:14 ` bug#62029: " João Távora
2023-03-08 21:28 ` Yuan Fu
2023-03-23 21:33 ` João Távora
2023-03-24 0:12 ` Yuan Fu
2023-03-24 17:44 ` João Távora
2023-03-25 3:04 ` Yuan Fu
2023-03-25 8:10 ` João Távora
2023-03-30 5:22 ` Yuan Fu
2023-03-30 8:13 ` João Távora [this message]
2023-03-30 8:25 ` Yuan Fu
2023-04-11 0:04 ` Dmitry Gutov
2023-04-11 11:25 ` João Távora
2023-04-12 1:38 ` Dmitry Gutov
2023-04-12 11:06 ` João Távora
2023-04-13 0:20 ` Dmitry Gutov
2023-04-13 4:20 ` Yuan Fu
2023-04-13 9:50 ` João Távora
2023-04-13 10:11 ` João Távora
2023-04-13 10:48 ` João Távora
2023-04-13 21:53 ` Dmitry Gutov
2023-04-13 22:13 ` Dmitry Gutov
2023-04-13 23:01 ` João Távora
2023-04-13 23:26 ` Dmitry Gutov
2023-04-14 0:04 ` João Távora
2023-04-14 23:50 ` Dmitry Gutov
2023-04-15 9:41 ` João Távora
2023-10-23 1:39 ` Dmitry Gutov
2023-04-18 0:47 ` Dmitry Gutov
2023-04-18 11:17 ` João Távora
2023-04-18 23:05 ` Dmitry Gutov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h6u2y7uj.fsf@gmail.com \
--to=joaotavora@gmail.com \
--cc=62029@debbugs.gnu.org \
--cc=casouri@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.