From 9fcee3c1d1eb6ce735dc69ee77b0c81900c19c3d Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sun, 7 Jul 2024 12:45:03 +0200 Subject: 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. --- lisp/emacs-lisp/checkdoc.el | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'lisp/emacs-lisp') 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") -- cgit v1.2.3