GNU bug report logs - #57772
icomplete-mode's docstring causes documentation function to fail

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 57772 in the body.
You can then email your comments to 57772 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: Brady Montz <bradymontz <at> mac.com>
To: bug-gnu-emacs <at> gnu.org
Subject: icomplete-mode's docstring causes documentation function to fail
Date: Tue, 13 Sep 2022 06:17:32 -0700

Hi, I noticed that when I have icomplete-mode enabled, the describe-mode function doesn't work in any buffer. It throws this error:

describe-map-tree: Wrong number of arguments: (lambda (map) "Display binding for MAP which must be a quoted keymap variable" (interactive (list (intern (completing-read "Key map: " obarray 'keymap-test 1)))) (let ((val (symbol-value map))) (or (keymapp val) (error "%s is not a keymap !" (symbol-name map))) (let* ((old-dir default-directory) (buf (save-current-buffer (set-buffer (get-buffer-create "*Help*")) (prog1 (current-buffer) (kill-all-local-variables) (setq default-directory old-dir) (setq buffer-read-only nil) (setq buffer-file-name nil) (setq buffer-undo-list t) (let ((inhibit-read-only t) (inhibit-modification-hooks t)) (erase-buffer) (run-hooks 'temp-buffer-setup-hook))))) (standard-output buf)) (prog1 (progn (princ (format "Binding for keymap %s is:
" (symbol-name map))) (princ (substitute-command-keys "\\{val}")) (print-help-return-message)) (internal-temp-output-buffer-show buf))))), 7

I did some debugging and traced it down to the icomplete-mode docstring. 

Repro:

in scratch buffer, run: (documentation 'icomplete-mode) and I get the same error. 

If I remove the last line of icomplete-mode's docstring ("\\{icomplete-minibuffer-map}"), then the documentation function successfully returns the doc string.

Finally, icomplete-minibuffer-map has the value (keymap (67108908 . icomplete-backward-completions) (67108910 . icomplete-forward-completions) (10 . icomplete-force-complete-and-exit) (remap keymap (minibuffer-complete-and-exit . icomplete-ret)) (27 keymap (9 . icomplete-force-complete))) after I’ve loaded it up. 

Unfortunately, describe-mode still doesn't work, so something else has a similar problem that I haven’t found yet, but likely this helps. 

Using emacs version "GNU Emacs 28.1 (build 1, x86_64-apple-darwin18.7.0, NS appkit-1671.60 Version 10.14.6 (Build 18G95))
 of 2022-05-11" built by homebrew, with the icomplete-mode that's included in that version. 

—
  Brady Montz
  bradymontz <at> mac.com

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Brady Montz <bradymontz <at> mac.com>
Cc: 57772 <at> debbugs.gnu.org
Subject: Re: bug#57772: icomplete-mode's docstring causes documentation
 function to fail
Date: Tue, 13 Sep 2022 16:43:27 +0200

Brady Montz <bradymontz <at> mac.com> writes:

> in scratch buffer, run: (documentation 'icomplete-mode) and I get the same error. 

I tried this now in Emacs 28.1, and I did not get an error.

Do you have a complete recipe to reproduce the problem, starting from
"emacs -Q"?

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

From: Brady Montz <bradymontz <at> mac.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57772 <at> debbugs.gnu.org
Subject: Re: bug#57772: icomplete-mode's docstring causes documentation
 function to fail
Date: Tue, 13 Sep 2022 08:11:44 -0700

Thanks for the quick reply!

OK, I shoulda checked emacs -Q first. Visual inspection of my .emacs didn’t show anything affecting incomplete-mode, but looks like something else in there is affecting it. 

I’ll take a look to see what’s interacting with it. 

Brady

> On Sep 13, 2022, at 7:43 AM, Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
> 
> Brady Montz <bradymontz <at> mac.com> writes:
> 
>> in scratch buffer, run: (documentation 'icomplete-mode) and I get the same error. 
> 
> I tried this now in Emacs 28.1, and I did not get an error.
> 
> Do you have a complete recipe to reproduce the problem, starting from
> "emacs -Q"?

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

From: Brady Montz <bradymontz <at> mac.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57772 <at> debbugs.gnu.org
Subject: Re: bug#57772: icomplete-mode's docstring causes documentation
 function to fail
Date: Tue, 13 Sep 2022 16:33:11 -0700

Alright, good news, false alarm. I found a function elsewhere that was overriding a key method inside of help.el, which was goofing up the keymap display in that particular use case. Can resolve as no issue. Thanks for the help!

Brady

> On Sep 13, 2022, at 8:11 AM, Brady Montz <bradymontz <at> mac.com> wrote:
> 
> Thanks for the quick reply!
> 
> OK, I shoulda checked emacs -Q first. Visual inspection of my .emacs didn’t show anything affecting incomplete-mode, but looks like something else in there is affecting it. 
> 
> I’ll take a look to see what’s interacting with it. 
> 
> Brady
> 
>> On Sep 13, 2022, at 7:43 AM, Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
>> 
>> Brady Montz <bradymontz <at> mac.com> writes:
>> 
>>> in scratch buffer, run: (documentation 'icomplete-mode) and I get the same error. 
>> 
>> I tried this now in Emacs 28.1, and I did not get an error.
>> 
>> Do you have a complete recipe to reproduce the problem, starting from
>> "emacs -Q"?
> 

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Brady Montz <bradymontz <at> mac.com>
Cc: 57772 <at> debbugs.gnu.org
Subject: Re: bug#57772: icomplete-mode's docstring causes documentation
 function to fail
Date: Wed, 14 Sep 2022 14:39:35 +0200

Brady Montz <bradymontz <at> mac.com> writes:

> Alright, good news, false alarm. I found a function elsewhere that was
> overriding a key method inside of help.el, which was goofing up the
> keymap display in that particular use case. Can resolve as no
> issue. Thanks for the help!

No problem; I'm closing this report, then.

Previous Next

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