From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 11 Jan 2025 04:05:14 +0000 (+0100)
Subject: Improve checkdoc-common-verbs-wrong-voice docstring
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=884a3b7295fe86d6e54be9a0620dfcd7f5477a97;p=emacs.git

Improve checkdoc-common-verbs-wrong-voice docstring

* lisp/emacs-lisp/checkdoc.el (checkdoc-common-verbs-wrong-voice):
Improve docstring.

(cherry picked from commit dabaea97465163c015890272c3d5001624690e08)
---

diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 16952454c47..aea179640cb 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -479,10 +479,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)))