GNU bug report logs - #67835
30.0.50; Error with undocumented disabled commands

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 67835 in the body.
You can then email your comments to 67835 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: kakkokakko <at> gmail.com
To: bug-gnu-emacs <at> gnu.org
Subject: 30.0.50; Error with undocumented disabled commands
Date: Fri, 15 Dec 2023 19:45:13 +0900

1. emacs -Q --eval "(progn (defun foo () (interactive)) (put 'foo 'disabled t))"
2. M-x foo RET

Then, I encountered the error message "Wrong type argument:
char-or-string-p, nil". This behavior is different from that in
previous versions, like 27.1, where I received the following message.

| You have invoked the disabled command foo.
| It is disabled because new users often find it confusing.
| Here’s the first part of its description:
| 
|    << not documented >>
| ...

I also expect similar behavior in 30.0.50.

In 30.0.50, it appears that disabled-command-function in
novice.el triggers this error by executing (insert nil) for
undocumented commands in the following code.

| (insert (condition-case ()
|             (documentation cmd)
|           (error "<< not documented >>")))

Although omitting a docstring is generally considered poor practice,
triggering an error for such commands might not be intentional
behavior. The corresponding code in 27.1 was as follows:

| (... (or (condition-case ()
|               (documentation cmd)
|            (error nil))
|          "<< not documented >>"))

-- 
KH

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: kakkokakko <at> gmail.com, Stefan Kangas <stefankangas <at> gmail.com>
Cc: 67835 <at> debbugs.gnu.org
Subject: Re: bug#67835: 30.0.50; Error with undocumented disabled commands
Date: Sat, 16 Dec 2023 15:11:24 +0200

> Date: Fri, 15 Dec 2023 19:45:13 +0900
> From: kakkokakko <at> gmail.com
> 
> 1. emacs -Q --eval "(progn (defun foo () (interactive)) (put 'foo 'disabled t))"
> 2. M-x foo RET
> 
> Then, I encountered the error message "Wrong type argument:
> char-or-string-p, nil". This behavior is different from that in
> previous versions, like 27.1, where I received the following message.
> 
> | You have invoked the disabled command foo.
> | It is disabled because new users often find it confusing.
> | Here’s the first part of its description:
> | 
> |    << not documented >>
> | ...
> 
> I also expect similar behavior in 30.0.50.
> 
> In 30.0.50, it appears that disabled-command-function in
> novice.el triggers this error by executing (insert nil) for
> undocumented commands in the following code.
> 
> | (insert (condition-case ()
> |             (documentation cmd)
> |           (error "<< not documented >>")))
> 
> Although omitting a docstring is generally considered poor practice,
> triggering an error for such commands might not be intentional
> behavior. The corresponding code in 27.1 was as follows:
> 
> | (... (or (condition-case ()
> |               (documentation cmd)
> |            (error nil))
> |          "<< not documented >>"))

Stefan, could you please look into this?  The above seems to come from
your changes in commit 6ad79059d2f843a1be617c72ae0e9d8a02c9a203.  I'd
like to fix this on the emacs-29 branch soon, if possible.

Thanks.

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>, kakkokakko <at> gmail.com
Cc: 67835-done <at> debbugs.gnu.org
Subject: Re: bug#67835: 30.0.50; Error with undocumented disabled commands
Date: Sat, 16 Dec 2023 11:37:13 -0800

Version: 29.2

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Fri, 15 Dec 2023 19:45:13 +0900
>> From: kakkokakko <at> gmail.com
>>
>> 1. emacs -Q --eval "(progn (defun foo () (interactive)) (put 'foo 'disabled t))"
>> 2. M-x foo RET
>>
>> Then, I encountered the error message "Wrong type argument:
>> char-or-string-p, nil". This behavior is different from that in
>> previous versions, like 27.1, where I received the following message.
>>
>> | You have invoked the disabled command foo.
>> | It is disabled because new users often find it confusing.
>> | Here’s the first part of its description:
>> |
>> |    << not documented >>
>> | ...
>>
>> I also expect similar behavior in 30.0.50.
>>
>> In 30.0.50, it appears that disabled-command-function in
>> novice.el triggers this error by executing (insert nil) for
>> undocumented commands in the following code.
>>
>> | (insert (condition-case ()
>> |             (documentation cmd)
>> |           (error "<< not documented >>")))
>>
>> Although omitting a docstring is generally considered poor practice,
>> triggering an error for such commands might not be intentional
>> behavior. The corresponding code in 27.1 was as follows:
>>
>> | (... (or (condition-case ()
>> |               (documentation cmd)
>> |            (error nil))
>> |          "<< not documented >>"))

Thanks for the bug report!

This should now be fixed on emacs-29.

Previous Next

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