summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2024-07-07 12:45:03 +0200
committerStefan Kangas <stefankangas@gmail.com>2024-07-07 12:45:03 +0200
commit9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d (patch)
treef4d9304661a3117492ec1c086a775e9fd4d29d6f /lisp/emacs-lisp
parentb249f022f1285aaf02705b6ac239d95e3b413c18 (diff)
downloademacs-9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d.tar.gz
emacs-9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d.tar.bz2
emacs-9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d.zip
Clarify `checkdoc-max-keyref-before-warn` docstring
* lisp/emacs-lisp/checkdoc.el (checkdoc-max-keyref-before-warn): Clarify and reflow docstring. Fix warning about overly long docstring.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/checkdoc.el17
1 files changed, 9 insertions, 8 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index c22dfb2eb26..fd25b0f981f 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -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")