GNU bug report logs - #68002
30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name

Previous Next

Package: emacs;

Reported by: Ihor Radchenko <yantar92 <at> posteo.net>

Date: Sun, 24 Dec 2023 10:37:02 UTC

Severity: normal

Found in version 30.0.50

Fixed in version 30.1

Done: Stefan Kangas <stefankangas <at> gmail.com>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#68002; Package emacs. (Sun, 24 Dec 2023 10:37:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ihor Radchenko <yantar92 <at> posteo.net>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sun, 24 Dec 2023 10:37:02 GMT) Full text and rfc822 format available.

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

From: Ihor Radchenko <yantar92 <at> posteo.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 30.0.50; checkdoc.el: False positive when a quote variable contains
 "C-g" in its name
Date: Sun, 24 Dec 2023 10:39:09 +0000
Hi,

I have the following docstring:

(defvar org-element--cache-interrupt-C-g-count 0
  "Current number of `org-element--cache-sync' calls.
See `org-element--cache-interrupt-C-g'.")

When I run M-x checkdoc, I am getting

   Keycode C-g embedded in doc string.  Use \\<mapvar> & \\[command] instead

Which is clearly false-positive.

May this be fixed?

In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.38, cairo version 1.18.0) of 2023-12-21 built on localhost
Repository revision: 6161f72efbf6625f60bf7f7d28d6c39a26e94a51
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101009
System Description: Gentoo Linux

Configured using:
 'configure --with-native-compilation'


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>




Reply sent to Stefan Kangas <stefankangas <at> gmail.com>:
You have taken responsibility. (Sun, 24 Dec 2023 13:30:02 GMT) Full text and rfc822 format available.

Notification sent to Ihor Radchenko <yantar92 <at> posteo.net>:
bug acknowledged by developer. (Sun, 24 Dec 2023 13:30:02 GMT) Full text and rfc822 format available.

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Ihor Radchenko <yantar92 <at> posteo.net>, 68002-done <at> debbugs.gnu.org
Subject: Re: bug#68002: 30.0.50; checkdoc.el: False positive when a quote
 variable contains "C-g" in its name
Date: Sun, 24 Dec 2023 05:29:37 -0800
Version: 30.1

Ihor Radchenko <yantar92 <at> posteo.net> writes:

> I have the following docstring:
>
> (defvar org-element--cache-interrupt-C-g-count 0
>   "Current number of `org-element--cache-sync' calls.
> See `org-element--cache-interrupt-C-g'.")
>
> When I run M-x checkdoc, I am getting
>
>    Keycode C-g embedded in doc string.  Use \\<mapvar> & \\[command] instead
>
> Which is clearly false-positive.
>
> May this be fixed?

Thanks for the bug report!

This should now be fixed on master.




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Mon, 22 Jan 2024 12:24:06 GMT) Full text and rfc822 format available.

This bug report was last modified 1 year and 207 days ago.

Previous Next


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