procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify checkdoc-max-keyref-before-warn docstring

Browse source 
* lisp/emacs-lisp/checkdoc.el (checkdoc-max-keyref-before-warn): Clarify
and reflow docstring.  Fix warning about overly long docstring.
This commit is contained in:
Stefan Kangas 2024-07-07 12:45:03 +02:00
parent b249f022f1
commit 9fcee3c1d1
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lisp/emacs-lisp/checkdoc.el
View file

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