summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/checkdoc.el
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2025-01-11 05:05:14 +0100
committerStefan Kangas <stefankangas@gmail.com>2025-01-11 05:18:14 +0100
commitdabaea97465163c015890272c3d5001624690e08 (patch)
tree166acd56bbaa70b9a78339890b8c3cf84581567d /lisp/emacs-lisp/checkdoc.el
parent6de2ee5663d5cc51831dbdafd77bd71e0811c37b (diff)
downloademacs-dabaea97465163c015890272c3d5001624690e08.tar.gz
emacs-dabaea97465163c015890272c3d5001624690e08.tar.bz2
emacs-dabaea97465163c015890272c3d5001624690e08.zip
Improve checkdoc-common-verbs-wrong-voice docstring
* lisp/emacs-lisp/checkdoc.el (checkdoc-common-verbs-wrong-voice): Improve docstring.
Diffstat (limited to 'lisp/emacs-lisp/checkdoc.el')
-rw-r--r--lisp/emacs-lisp/checkdoc.el8
1 files changed, 4 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index d6e94789c07..e6c2b8306be 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -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)))