summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorPo Lu <luangruo@yahoo.com>2024-07-08 15:43:55 +0800
committerPo Lu <luangruo@yahoo.com>2024-07-08 15:43:55 +0800
commitdf1630ad3b85538b86f054073364c9ba0c989909 (patch)
treea18e619b608c0df3618931a116f13a836889e92a /lisp/emacs-lisp
parent4d21dff571477ca0308293815f3025897bc089a4 (diff)
parentf4c0459ed3edce33329744f60a0e389c20dc60a5 (diff)
downloademacs-df1630ad3b85538b86f054073364c9ba0c989909.tar.gz
emacs-df1630ad3b85538b86f054073364c9ba0c989909.tar.bz2
emacs-df1630ad3b85538b86f054073364c9ba0c989909.zip
Merge from savannah/emacs-30
f4c0459ed3e Fix Tramp parser 47c79b62dd0 Checkdoc fixes in progmodes 6757f8e67d3 Checkdoc fixes in Org Mode 9fcee3c1d1e Clarify `checkdoc-max-keyref-before-warn` docstring b249f022f12 * lisp/files.el (insert-directory): Quote switches in wil... 8911d53ce5d Fix uses of 'dired-omit-mode' (bug#71905)
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 de6f0258e97..252dd5cbf83 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")