procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

checkdoc: Avoid false positive for keybinding in docstring

Browse source 
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
Avoid false positive when a variable contains a keybinding (for
example, "C-g").  (Bug#68002)
* test/lisp/emacs-lisp/checkdoc-tests.el
(checkdoc-docstring-avoid-false-positive-ok): New test.
This commit is contained in:
Stefan Kangas 2023-12-24 14:27:48 +01:00
parent 2a1a7a8524
commit 13e46e2c1d
2 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lisp/emacs-lisp/checkdoc.el
View file

@ -1611,8 +1611,11 @@ may require more formatting")
(let ((f nil) (m nil) (start (point))
;; Ignore the "A-" modifier: it is uncommon in practice,
;; and leads to false positives in regexp ranges.
(re "[^`‘A-Za-z0-9_]\\([CMs]-[a-zA-Z]\\|\\(\\([CMs]-\\)?\
mouse-[0-3]\\)\\)\\>"))
(re (rx (not (any "0-9A-Za-z_`‘-"))
(group (or (seq (any "CMs") "-" (any "A-Za-z"))
(group (opt (group (any "CMs") "-"))
"mouse-" (any "0-3"))))
eow)))
;; Find the first key sequence not in a sample
(while (and (not f) (setq m (re-search-forward re e t)))
(setq f (not (checkdoc-in-sample-code-p start e))))