From: "João Távora" <joaotavora@gmail.com>
To: Yuan Fu <casouri@gmail.com>
Cc: Stephen Leake <stephen_leake@stephe-leake.org>,
Emacs developers <emacs-devel@gnu.org>
Subject: Re: [SPAM UNSURE] Explain a bit more on how to configure language server in Eglot's manual
Date: Tue, 07 Mar 2023 11:59:32 +0000 [thread overview]
Message-ID: <87356gvkkb.fsf@gmail.com> (raw)
In-Reply-To: <AC3C8D5F-7543-42FE-823C-A3F8E4BA2CAE@gmail.com> (Yuan Fu's message of "Mon, 6 Mar 2023 14:28:38 -0800")
Yuan Fu <casouri@gmail.com> writes:
>> On Mar 5, 2023, at 4:16 PM, João Távora <joaotavora@gmail.com> wrote:
>>
>> Yuan, please show the patch to Eglot's manual and let's work from
>> there.
>
> I’m not an amazing writer, but here it is.
Thanks. I think the most important part in your patch is to show me
exactly the points in the manual's writing that are confusing.
>> I'm also OK with adding more examples, and work on simplifying the
>> per-project configuration workflow, maybe by somehow making it
>> easier to translate that dotted path notation into the nested JSON
>> object that the server is ultimately looking for.
>
> I feel that explaining the relationship between the dotted notation,
> the JSON object and the plist value that eglot accepts is already some
> cognitive load. And adding a translator into the mix will make it
> worse. If we provide the translator but don’t explain how it works, it
> will be just as confusing. But I could be wrong, I didn’t ponder this
> too deeply.
The dotted-to-plist translator proposed is optional. Some people
requested use of dotted notation and that will surely need a translator.
I wouldn't use it.
But you're right that it's orthogonal to the request of a clearly and
well-structured writing on this topic, which I agree that this version
of the manual doesn't offer (the old Eglot README was very slightly
better in this department, IIRC)
>> If this distinction is not clear in the manual, either, it should
>> be made so.
>
> initializatiOption is only mentioned in the documentation of
> eglot-server-progrems, while workspaceConfiguration has a dozen
> paragraphs devoted to it. So maybe it’s easy to take
> workspaceConfiguration as the “main” way to configure a server.
No, there are two ways, and neither is more valuable than the other. It
depends entirely on what the user wants.
> Maybe we can spend a little bit of text noting initializationOption
> under the “Customizing eglot” section.
I'm leaning into making a dedicated "Server configuration" section with
3 subsections: initializationOptions, eglot-workspace-configuration, and
the representations of common JSON object that is used for both of them.
João
next prev parent reply other threads:[~2023-03-07 11:59 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-05 4:45 Explain a bit more on how to configure language server in Eglot's manual Yuan Fu
2023-03-05 22:36 ` [SPAM UNSURE] " Stephen Leake
2023-03-06 0:16 ` João Távora
2023-03-06 22:28 ` Yuan Fu
2023-03-07 11:59 ` João Távora [this message]
2023-03-08 13:27 ` Augusto Stoffel
2023-03-08 13:54 ` João Távora
2023-03-08 15:01 ` Augusto Stoffel
2023-03-08 19:43 ` João Távora
2023-03-08 20:43 ` Augusto Stoffel
2023-03-09 9:43 ` João Távora
2023-03-08 23:19 ` Yuan Fu
2023-03-09 8:18 ` Augusto Stoffel
2023-03-09 17:20 ` Juri Linkov
2023-03-10 6:26 ` Yuan Fu
2023-03-10 7:59 ` João Távora
2023-03-09 17:40 ` João Távora
2023-03-09 18:05 ` Juri Linkov
2023-03-09 18:32 ` Augusto Stoffel
2023-03-09 8:28 ` Explain a bit more on how to configure language server in Eglot's manual' Augusto Stoffel
2023-03-08 15:24 ` Explain a bit more on how to configure language server in Eglot's manual Yuri Khan
2023-03-08 15:27 ` João Távora
2023-03-08 15:52 ` Yuri Khan
2023-03-08 16:03 ` João Távora
2023-03-09 11:18 ` [SPAM UNSURE] " João Távora
2023-03-10 6:23 ` Yuan Fu
2023-03-14 18:09 ` Michael Eliachevitch
2023-03-14 18:53 ` João Távora
2023-03-14 22:27 ` [PATCH] " Michael Eliachevitch
2023-03-15 11:49 ` Michael Eliachevitch
2023-03-15 12:35 ` Eli Zaretskii
2023-03-15 12:52 ` Michael Eliachevitch
2023-03-15 18:54 ` João Távora
2023-03-15 19:26 ` Michael Eliachevitch
2023-03-16 0:09 ` João Távora
2023-03-06 10:34 ` Augusto Stoffel
2023-03-06 10:51 ` João Távora
2023-03-06 11:00 ` Augusto Stoffel
2023-03-06 11:13 ` João Távora
2023-03-06 11:30 ` Pedro Andres Aranda Gutierrez
2023-03-06 11:46 ` João Távora
2023-03-06 13:08 ` Augusto Stoffel
2023-03-06 13:50 ` João Távora
2023-03-06 16:10 ` Augusto Stoffel
2023-03-06 16:25 ` João Távora
2023-03-06 18:18 ` Augusto Stoffel
2023-03-06 18:32 ` João Távora
2023-03-06 20:16 ` Pedro Andres Aranda Gutierrez
2023-03-06 21:13 ` Augusto Stoffel
2023-03-06 21:38 ` João Távora
2023-03-06 13:01 ` Augusto Stoffel
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87356gvkkb.fsf@gmail.com \
--to=joaotavora@gmail.com \
--cc=casouri@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=stephen_leake@stephe-leake.org \
/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 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).