Improve checkdoc-common-verbs-wrong-voice docstring

* lisp/emacs-lisp/checkdoc.el (checkdoc-common-verbs-wrong-voice):
Improve docstring.
This commit is contained in:
Stefan Kangas 2025-01-11 05:05:14 +01:00
parent 6de2ee5663
commit dabaea9746

View file

@ -484,10 +484,10 @@ this to anything but t is likely to be counter-productive.")
("yanks" . "yank")
)
"Alist of common words in the wrong voice and what should be used instead.
Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
and experimental check. Do not modify this list without setting
the value of `checkdoc-common-verbs-regexp' to nil which cause it to
be re-created.")
Set `checkdoc-verb-check-experimental-flag' to a non-nil value to enable
this experimental check. Do not modify this list without setting the
value of `checkdoc-common-verbs-regexp' to nil, which causes it to be
re-created.")
(defvar checkdoc-syntax-table
(let ((st (make-syntax-table emacs-lisp-mode-syntax-table)))