GNU logs - #78530, boring messages

Message sent to joaotavora@HIDDEN, bug-gnu-emacs@HIDDEN:

Subject: bug#78530: 31.0.50; [PATCH] eglot-code-action-suggestion doesn't call the  callback function in the original buffer
Resent-From: Yuan Fu <casouri@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: joaotavora@HIDDEN, bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 21 May 2025 07:43:02 +0000
Resent-Message-ID: <handler.78530.B.17478133709062 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 78530 <at> debbugs.gnu.org
Cc: joaotavora@HIDDEN
From: Yuan Fu <casouri@HIDDEN>
Content-Type: multipart/mixed;
 boundary="Apple-Mail=_E636F0BA-AD06-41F0-9B31-BEEC4A5D7D94"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3826.500.181.1.5\))
Message-Id: <C109BFA6-1DB1-48F6-83FF-3490E36561C5@HIDDEN>
Date: Wed, 21 May 2025 00:42:21 -0700
Received-SPF: pass client-ip=2607:f8b0:4864:20::42b;
 envelope-from=casouri@HIDDEN; helo=mail-pf1-x42b.google.com
X-Spam_score_int: -10
X-Spam_score: -1.1
X-Spam_bar: -
X-Spam_report: (-1.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001,
 FREEMAIL_REPLY=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=no autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 1.0 (+)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.0 (/)


--Apple-Mail=_E636F0BA-AD06-41F0-9B31-BEEC4A5D7D94
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
	charset=utf-8

X-Debbugs-CC: joaotavora@HIDDEN

Copying from the commit message:

Some minor modes adds their own eldoc display function to
'eldoc-display-functions' hook buffer-locally.  So when eldoc
uses 'eldoc-display-functions' to display docs, it should use
the buffer-local value of the hook.

In 'eldoc--invoke-strategy', the code that runs
'eldoc-display-functions' hook is wrapped in a callback function
that eventually gets passed to each documentation function in
'eldoc-documentation-functions'. So now it's the documentation
functions' responsibility to call the eldoc callback in the
original buffer.

All the eglot documentation functions indeed do that, using
'eglot--when-buffer-window' to switch to the original buffer when
calling the eldoc callback. Except for
'eglot-code-action-suggestion'.

This patch fixes that.

This bug was originally reported on eldoc-box [1]. The user
found that eldoc-box's display function are rarely used, while
the minor mode is turned on. This patch fixes the issue.

[1] =
https://github.com/casouri/eldoc-box/issues/126#issuecomment-2896611278

I think we should fix the eldoc callback function so it always uses the
hook value of the hook in the original buffer; at the very least we
should document the pitfall in the docstring of
eldoc-documentation-functions. Jo=C3=A3o, WDYT?

Yuan


--Apple-Mail=_E636F0BA-AD06-41F0-9B31-BEEC4A5D7D94
Content-Disposition: attachment;
	filename=eglot-code-action.patch
Content-Type: application/octet-stream;
	x-unix-mode=0644;
	name="eglot-code-action.patch"
Content-Transfer-Encoding: quoted-printable

=46rom=200a0a72d16b2508b629f1bda8caddac8844452707=20Mon=20Sep=2017=20=
00:00:00=202001=0AFrom:=20Yuan=20Fu=20<casouri@HIDDEN>=0ADate:=20Wed,=20=
21=20May=202025=2000:23:15=20-0700=0ASubject:=20[PATCH]=20Make=20=
eglot-code-action-suggestion=20call=20callback=20in=20orig=0A=20buffer=0A=
=0ASome=20minor=20modes=20adds=20their=20own=20eldoc=20display=20=
function=20to=0A'eldoc-display-functions'=20hook=20buffer-locally.=20=20=
So=20when=20eldoc=0Auses=20'eldoc-display-functions'=20to=20display=20=
docs,=20it=20should=20use=0Athe=20buffer-local=20value=20of=20the=20=
hook.=0A=0AIn=20'eldoc--invoke-strategy',=20the=20code=20that=20runs=0A=
'eldoc-display-functions'=20hook=20is=20wrapped=20in=20a=20callback=20=
function=0Athat=20eventually=20gets=20passed=20to=20each=20documentation=20=
function=20in=0A'eldoc-documentation-functions'.=20So=20now=20it's=20the=20=
documentation=0Afunctions'=20responsibility=20to=20call=20the=20eldoc=20=
callback=20in=20the=0Aoriginal=20buffer.=0A=0AAll=20the=20eglot=20=
documentation=20functions=20indeed=20do=20that,=20using=0A=
'eglot--when-buffer-window'=20to=20switch=20to=20the=20original=20buffer=20=
when=0Acalling=20the=20eldoc=20callback.=20Except=20for=0A=
'eglot-code-action-suggestion'.=0A=0AThis=20patch=20fixes=20that.=0A=0A=
This=20bug=20was=20originally=20reported=20on=20eldoc-box=20[1].=20The=20=
user=0Afound=20that=20eldoc-box's=20display=20function=20are=20rarely=20=
used,=20while=0Athe=20minor=20mode=20is=20turned=20on.=20This=20patch=20=
fixes=20the=20issue.=0A=0A[1]=20=
https://github.com/casouri/eldoc-box/issues/126#issuecomment-2896611278=0A=
=0A*=20lisp/progmodes/eglot.el=20(eglot-code-action-suggestion):=20Move=0A=
the=20funcall=20form=20into=20the=20eglot--when-buffer-window=20form.=0A=
---=0A=20lisp/progmodes/eglot.el=20|=204=20++--=0A=201=20file=20changed,=20=
2=20insertions(+),=202=20deletions(-)=0A=0Adiff=20--git=20=
a/lisp/progmodes/eglot.el=20b/lisp/progmodes/eglot.el=0Aindex=20=
6f6b05a393d..5bb825189f2=20100644=0A---=20a/lisp/progmodes/eglot.el=0A=
+++=20b/lisp/progmodes/eglot.el=0A@@=20-4168,8=20+4168,8=20@@=20=
eglot-code-action-suggestion=0A=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
'display=0A=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20`((margin=20=
left-margin)=0A=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
,tooltip)))))=0A-=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=
(setq=20eglot--suggestion-overlay=20ov)))))=0A-=20=20=20=20=20=20=20=20=20=
(when=20use-text-p=20(funcall=20cb=20blurb)))=0A+=20=20=20=20=20=20=20=20=
=20=20=20=20=20=20=20=20=20(setq=20eglot--suggestion-overlay=20ov))))=0A=
+=20=20=20=20=20=20=20=20=20=20=20(when=20use-text-p=20(funcall=20cb=20=
blurb))))=0A=20=20=20=20=20=20=20=20:hint=20:textDocument/codeAction)=0A=20=
=20=20=20=20=20=20(and=20use-text-p=20t))))=0A=20=0A--=20=0A2.39.5=20=
(Apple=20Git-154)=0A=0A=

--Apple-Mail=_E636F0BA-AD06-41F0-9B31-BEEC4A5D7D94--

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Yuan Fu <casouri@HIDDEN>
Subject: bug#78530: Acknowledgement (31.0.50; [PATCH] eglot-code-action-suggestion
 doesn't call the  callback function in the original buffer)
Message-ID: <handler.78530.B.17478133709062.ack <at> debbugs.gnu.org>
References: <C109BFA6-1DB1-48F6-83FF-3490E36561C5@HIDDEN>
X-Gnu-PR-Message: ack 78530
X-Gnu-PR-Package: emacs
X-Gnu-PR-Keywords: patch
Reply-To: 78530 <at> debbugs.gnu.org
Date: Wed, 21 May 2025 07:43:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

As you requested using X-Debbugs-CC, your message was also forwarded to
  joaotavora@HIDDEN
(after having been given a bug report number, if it did not have one).

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 78530 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
78530: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D78530
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#78530: 31.0.50; [PATCH] eglot-code-action-suggestion doesn't call the callback function in the original buffer
Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 21 May 2025 11:21:02 +0000
Resent-Message-ID: <handler.78530.B78530.174782641518912 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Yuan Fu <casouri@HIDDEN>
Cc: 78530 <at> debbugs.gnu.org
MIME-Version: 1.0
References: <C109BFA6-1DB1-48F6-83FF-3490E36561C5@HIDDEN>
In-Reply-To: <C109BFA6-1DB1-48F6-83FF-3490E36561C5@HIDDEN>
From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
Date: Wed, 21 May 2025 12:20:39 +0100
Message-ID: <CALDnm52xuSoA9BGSqX6-8qGpOx=9bwGJ2mpebuiHu71NRnckDA@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Good catch, good analysis and great commit message.

Just please rename the subject line of the commit message to
start with "Eglot: " if you can.  Makes it easier to identify.  For example=
:

Eglot: always call ElDoc callbacks in correct buffer

Then add a reference to this bug#78530 and push at will.

Jo=C3=A3o

Last modified: Wed, 21 May 2025 11:30:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.