Improve checkdoc-common-verbs-wrong-voice docstring
authorStefan Kangas <stefankangas@gmail.com>
Sat, 11 Jan 2025 04:05:14 +0000 (05:05 +0100)
committerStefan Kangas <stefankangas@gmail.com>
Sat, 11 Jan 2025 04:18:14 +0000 (05:18 +0100)
* lisp/emacs-lisp/checkdoc.el (checkdoc-common-verbs-wrong-voice):
Improve docstring.

lisp/emacs-lisp/checkdoc.el

index d6e94789c07d6258e18d8a7442acd6a1e208f79b..e6c2b8306be81a0cd2344ae5d786ae1ffa84ac67 100644 (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)))