diff options
Diffstat (limited to 'lisp/emacs-lisp/checkdoc.el')
| -rw-r--r-- | lisp/emacs-lisp/checkdoc.el | 17 |
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") |