From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Newsgroups: gmane.emacs.bugs Subject: bug#58893: 29.0.50; Feedback on Eglot manual Date: Wed, 2 Nov 2022 08:26:00 +0000 Message-ID: References: <874jvlk5pm.fsf@betli.tmit.bme.hu> <83o7ttfvto.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="00000000000054d2b905ec789468" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1961"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Felician Nemeth , 58893@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Nov 02 09:27:24 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oq95m-0000Jg-04 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 02 Nov 2022 09:27:22 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oq94i-0005Pa-AY; Wed, 02 Nov 2022 04:26:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oq94U-0005Mg-U1 for bug-gnu-emacs@gnu.org; Wed, 02 Nov 2022 04:26:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oq94U-000423-Hp for bug-gnu-emacs@gnu.org; Wed, 02 Nov 2022 04:26:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oq94U-0002Rr-Bz for bug-gnu-emacs@gnu.org; Wed, 02 Nov 2022 04:26:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 02 Nov 2022 08:26:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 58893 X-GNU-PR-Package: emacs Original-Received: via spool by 58893-submit@debbugs.gnu.org id=B58893.16673775219359 (code B ref 58893); Wed, 02 Nov 2022 08:26:02 +0000 Original-Received: (at 58893) by debbugs.gnu.org; 2 Nov 2022 08:25:21 +0000 Original-Received: from localhost ([127.0.0.1]:44872 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oq93o-0002Qt-V2 for submit@debbugs.gnu.org; Wed, 02 Nov 2022 04:25:21 -0400 Original-Received: from mail-oa1-f48.google.com ([209.85.160.48]:46908) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oq93m-0002Qd-8I for 58893@debbugs.gnu.org; Wed, 02 Nov 2022 04:25:18 -0400 Original-Received: by mail-oa1-f48.google.com with SMTP id 586e51a60fabf-13b6c1c89bdso19520901fac.13 for <58893@debbugs.gnu.org>; Wed, 02 Nov 2022 01:25:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=rrqoAId9bU2tKjxCYrdSx9EuqpSfkakPVwvflsLwWK8=; b=nAjUoZLCLXRP6/dornTEbCbGB+V+IRoRB234ab4rWjpy2lBJQ3WDVbTSn12EEATbLX BWu7QOxQ8LdYiS6LgA6IZy0TawYB6DRgksuhJcK5c6wnwUcRcXgJkEfa91b8luwToOlx RKMZlTxvToTV6MgfmOon4Qlz1d6aQL4M81vPka+ST3s0iJQZSm1xLHPsBB1em9vQJlDi 3tDbr14bfHeMpVMcOySnlYpWp+eGfMcfl8ckaQBYgbfy4bqA9oYWbdxbrfjj6mAAVDTn KL9RGnygzPknHCWBTCvRpCzRYvmajw1quPASB2xw8Elhj1GjXkDkayf+Iv4qGTlHIHAh RHaA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=rrqoAId9bU2tKjxCYrdSx9EuqpSfkakPVwvflsLwWK8=; b=1g/oxr6v/h/EuP13f6kgGZ/Dxvb758WvrSMwucXgwb62hynuTnVBGSMQcEUt3ZuVPt ElVanm7xy16OTiTd2va1zCQbNFQ80Vaacg/k0p6snPulEYm/c3jHM5XuD50QhWypW7fB b6sqKWivnBAKfvevfiZfNLm0EZIR1CdP8xipOLH1UmwiabBl1v86YsWQVihUMNB3arWR EQm36WMd4DOGh1gShBW306mD1rt5/r1j9jI/mG08Bmc8drDwEDxneuYcPi0XbYo3hiAw tigWyGuGqBrzwpm1IAiXe7EEDpqAoq4FB3ih+7DSz19CoFzF57jE2T7EPRfj+XEBSLw/ ZzBQ== X-Gm-Message-State: ACrzQf0oHmeUeczOCG12T4wzwhLtjtJ1z600uhLXJKDZQI/KzyqNUCeu OtabeAULysgf7Vi9RcgaUegEOzI3mHRTe8+0fV0= X-Google-Smtp-Source: AMsMyM6B2Z9izarvx8ZZ0HZ1OZWB2tFx+mQEQ3eBVbIT6Iq6F/tY+We8t13MUJV+LsXSEWo/hnUrQQCodjRFlxqqrUo= X-Received: by 2002:a05:6870:e242:b0:13b:d561:ad02 with SMTP id d2-20020a056870e24200b0013bd561ad02mr14200438oac.215.1667377512369; Wed, 02 Nov 2022 01:25:12 -0700 (PDT) In-Reply-To: <83o7ttfvto.fsf@gnu.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: "bug-gnu-emacs" Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:246849 Archived-At: --00000000000054d2b905ec789468 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Sun, Oct 30, 2022 at 10:31 AM Eli Zaretskii wrote: > > > From: Felician Nemeth > The Eglot-specific commands you mention are AFAIU direct calls to the > Eglot's Xref backend, so why do we need to describe them in the > manual, when Xref itself is already described? I think what Felici=C3=A1n may be hinting at, and I agree, is that Eglot is Emacs's identifiable frontend to "code intelligence" features for many new users. We observed this many times. Users almost never know anything about Xref, Flymake, Eldoc, etc and these facilities. Rather they think it's Eglot that it "does" the definition-finding, diagnostics, documentatio= n respectively. This is not technically correct, and we do clarify it to those users, but it is also not at all unreasonable for a new user. Also many new users com from the lsp-mode package where these things are effectively all "done" by the package. The former README went to lengths to give visibility to them, and it was quite effective. This is not entirely lost in the new manual, but is much less obvious. I understand both points of view, though. Perhaps the solution is to more prominently advertise the Xref, the Flymake and the Eldoc manuals (and Eglot's of course) in some "Emacs IDE tutorial manual". > I'm not sure what exactly are you proposing to mention in the manual > in this respect. If we are going to add the description of how to add > directories to a project, then yes, Eglot should be mentioned there > (but only in passing, IMO, since Eglot follows the project settings > automatically, AFAIU). Yes, I think Felici=C3=A1n's idea makes sense. There's already a part of a manual about workspace folders in the descriptino of eglot-workspace-configuration. But it should really be brought into a dedicated section about LSP workspace folders and Eglot's translation of Emacs abstractions to them. This a common pain point for many users, and they have to be able to look it up quickly. > > * Snippet completion > > > > Yasnippet should be enabled in the current buffer before Eglot connects > > to the LSP server. Felici=C3=A1n, are you sure? If that's true, then I think it's a bug. I d= on't want users to have to remember this. So I think the current gist "just install yasnippet" should be enough. --00000000000054d2b905ec789468 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
On Sun, Oct 30, 2022 at 10:31 AM Eli Zaretskii <eliz@gnu.org> wrote:
>
> > F= rom: Felician Nemeth <felic= ian.nemeth@gmail.com>

> The Eglot-specific commands you me= ntion are AFAIU direct calls to the
> Eglot's Xref backend, so wh= y do we need to describe them in the
> manual, when Xref itself is al= ready described?

I think what Felici=C3=A1n may be hinting at, and I= agree, is that Eglot is
Emacs's identifiable frontend to "code= intelligence" features for
many new users.=C2=A0 We observed this = many times. Users almost never know
anything about Xref, Flymake, Eldoc,= etc and these facilities.=C2=A0 Rather they think
it's Eglot that i= t "does" the definition-finding, diagnostics, documentation
= =C2=A0respectively. This is not technically correct, and we do clarify it t= o those
users, but it is also not at all unreasonable for a new user.
Also many new users com from the lsp-mode package where these thingsare effectively all "done" by the package.

The former RE= ADME went to lengths to give visibility to them,
and it was quite effect= ive.=C2=A0 This is not entirely lost in the new manual,
but is much less= obvious.

I understand both points of view, though.=C2=A0 Perhaps th= e solution is
to more prominently advertise the Xref, the Flymake and th= e Eldoc
manuals (and Eglot's =C2=A0of course) in some "Emacs ID= E tutorial manual".

> I'm not sure what exactly are you = proposing to mention in the manual
> in this respect.=C2=A0 If we are= going to add the description of how to add
> directories to a projec= t, then yes, Eglot should be mentioned there
> (but only in passing, = IMO, since Eglot follows the project settings
> automatically, A= FAIU).=C2=A0

Yes, I think Felici=C3=A1n's= idea makes sense.=C2=A0 There's already a part of
a man= ual about workspace folders in the descriptino of
eglot-work= space-configuration.

But it should really be broug= ht into a dedicated section about LSP workspace
folders and = Eglot's translation of Emacs abstractions to them.=C2=A0 This a
common pain point for many users, and they have to be able to look<= /div>
it up quickly.

> > * Snippet completion
>= ; >
> > Yasnippet should be enabled in the current buffer befor= e Eglot connects
> > to the LSP server.

<= div>Felici=C3=A1n, are you sure?=C2=A0 If that's true, then I think it&= #39;s a bug.=C2=A0 I don't want users
to have to remember thi= s.=C2=A0 So I think the current gist "just install yasnippet"
should be enough.
--00000000000054d2b905ec789468--