GNU bug report logs - #72634
Documentation correction in eglot.texi

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 72634 in the body.
You can then email your comments to 72634 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: david edmonds <edmonds.david.a <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Documentation correction in eglot.texi
Date: Thu, 15 Aug 2024 14:09:59 +1000

[Message part 1 (text/plain, inline)]

eglot-managed-p is a function, not a variable.

The documentation states that to check whether a buffer is managed by
eglot the user should, for example:  (if eglot-managed-p ...). But in
fact, what is required is: (if (eglot-managed-p) ...).
---
 doc/misc/eglot.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/misc/eglot.texi b/doc/misc/eglot.texi
index ba7aeb448e5..fb5b618bd84 100644
--- a/doc/misc/eglot.texi
+++ b/doc/misc/eglot.texi
@@ -600,7 +600,7 @@ user, but automatically, as the result of starting an
Eglot session
 for the buffer.  However, this minor mode provides a hook variable
 @code{eglot-managed-mode-hook} that can be used to customize the Eglot
 management of the buffer.  This hook is run both when the minor mode
-is turned on and when it's turned off; use the variable
+is turned on and when it's turned off; use the function
 @code{eglot-managed-p} to tell if current buffer is still being
 managed or not.  When Eglot stops managing the buffer, this minor mode
 is turned off, and all the settings that Eglot changed are restored to
-- 
2.46.0

[Message part 2 (text/html, inline)]

Message #10 received at 72634-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: david edmonds <edmonds.david.a <at> gmail.com>
Cc: 72634-done <at> debbugs.gnu.org
Subject: Re: bug#72634: Documentation correction in eglot.texi
Date: Sat, 17 Aug 2024 13:08:55 +0300

> From: david edmonds <edmonds.david.a <at> gmail.com>
> Date: Thu, 15 Aug 2024 14:09:59 +1000
> 
> eglot-managed-p is a function, not a variable.
> 
> The documentation states that to check whether a buffer is managed by
> eglot the user should, for example:  (if eglot-managed-p ...). But in
> fact, what is required is: (if (eglot-managed-p) ...).

Thanks, installed on the emacs-30 branch, and closing the bug.

Previous Next

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