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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#68002: closed (30.0.50; checkdoc.el: False positive when a
 quote variable contains "C-g" in its name)
Date: Sun, 24 Dec 2023 13:30:02 +0000

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

Your message dated Sun, 24 Dec 2023 05:29:37 -0800
with message-id <CADwFkmn0JLnLXUJd=ucaYfEXukRV+H9s7cN_=QpRXNfseRVSFA <at> mail.gmail.com>
and subject line Re: bug#68002: 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name
has caused the debbugs.gnu.org bug report #68002,
regarding 30.0.50; checkdoc.el: False positive when a quote variable contains "C-g" in its name
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
68002: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68002
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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>

[Message part 3 (message/rfc822, inline)]

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.

Previous Next

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