Variable: checkdoc-max-keyref-before-warn

checkdoc-max-keyref-before-warn is a customizable variable defined in checkdoc.el.gz.

Value

nil

Documentation

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.

This variable was added, or its default value changed, in Emacs 28.1.

Probably introduced at or before Emacs version 28.1.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/checkdoc.el.gz
;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'list-of-strings-p)

(defcustom checkdoc-max-keyref-before-warn nil
  "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")