Clarify `checkdoc-max-keyref-before-warn` docstring
authorStefan Kangas <stefankangas@gmail.com>
Sun, 7 Jul 2024 10:45:03 +0000 (12:45 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Sun, 7 Jul 2024 10:45:03 +0000 (12:45 +0200)
* lisp/emacs-lisp/checkdoc.el (checkdoc-max-keyref-before-warn): Clarify
and reflow docstring.  Fix warning about overly long docstring.

lisp/emacs-lisp/checkdoc.el

index c22dfb2eb26d1dbbb52ef5ff09ca959928191554..fd25b0f981fe2766428c0e383eabe5ac43239bc3 100644 (file)
@@ -262,14 +262,15 @@ with these words enabled."
 ;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'list-of-strings-p)
 
 (defcustom checkdoc-max-keyref-before-warn nil
-  "If non-nil, number of \\\\=[command-to-keystroke] tokens allowed in a doc string.
-Any more than this and a warning is generated suggesting that the construct
-\\\\={mapvar} be used instead.  If the value is nil, never warn.
-
-It used to not be practical to use `\\\\=[...]' very many times,
-because display of the documentation string would become slow.
-This is not an issue on modern machines, unless you have
-thousands of substitutions."
+  "Maximum number of \\\\=[command-to-keystroke] tokens allowed in a doc string.
+
+Any more than this and a warning is generated suggesting that the
+construct \\\\={mapvar} be used instead.  If the value is nil, never
+warn.
+
+It used to be impractical to use `\\\\=[...]' very many times, because
+display of the documentation string would become slow.  This is not an
+issue on modern machines, unless you have thousands of substitutions."
   :type '(choice (const nil)
                  integer)
   :version "28.1")