aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2024-07-07 12:45:03 +0200
committerStefan Kangas2024-07-07 12:45:03 +0200
commit9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d (patch)
treef4d9304661a3117492ec1c086a775e9fd4d29d6f
parentb249f022f1285aaf02705b6ac239d95e3b413c18 (diff)
downloademacs-9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d.tar.gz
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.
-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."
262;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'list-of-strings-p) 262;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'list-of-strings-p)
263 263
264(defcustom checkdoc-max-keyref-before-warn nil 264(defcustom checkdoc-max-keyref-before-warn nil
265 "If non-nil, number of \\\\=[command-to-keystroke] tokens allowed in a doc string. 265 "Maximum number of \\\\=[command-to-keystroke] tokens allowed in a doc string.
266Any more than this and a warning is generated suggesting that the construct 266
267\\\\={mapvar} be used instead. If the value is nil, never warn. 267Any more than this and a warning is generated suggesting that the
268 268construct \\\\={mapvar} be used instead. If the value is nil, never
269It used to not be practical to use `\\\\=[...]' very many times, 269warn.
270because display of the documentation string would become slow. 270
271This is not an issue on modern machines, unless you have 271It used to be impractical to use `\\\\=[...]' very many times, because
272thousands of substitutions." 272display of the documentation string would become slow. This is not an
273issue on modern machines, unless you have thousands of substitutions."
273 :type '(choice (const nil) 274 :type '(choice (const nil)
274 integer) 275 integer)
275 :version "28.1") 276 :version "28.1")