From 8618e86acd93a0d6fc02ccb2de493c2be1ac795a Mon Sep 17 00:00:00 2001 From: Nikolay Kudryavtsev Date: Wed, 29 Sep 2021 22:33:49 +0300 Subject: [PATCH] checkdoc: Docstring substitution consistent with other docs. * lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine): In error text return "MAPVAR" instead of "keymap" and "COMMAND" instead of "function". --- lisp/emacs-lisp/checkdoc.el | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index 5ea2f59ee6..16918746ca 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -254,7 +254,7 @@ checkdoc-ispell-lisp-words (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 -\\\\={keymap} be used instead. If the value is nil, never warn. +\\\\={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. @@ -1626,7 +1626,7 @@ checkdoc-this-string-valid-engine (checkdoc-create-error (concat "Keycode " (match-string 1) - " embedded in doc string. Use \\\\ & \\\\[function] " + " embedded in doc string. Use \\\\ & \\\\[COMMAND] " "instead") (match-beginning 1) (match-end 1) t)))) ;; Optionally warn about too many command substitutions. @@ -1636,7 +1636,7 @@ checkdoc-this-string-valid-engine (1+ checkdoc-max-keyref-before-warn)) (not (re-search-forward "\\\\\\\\{\\w+}" e t))) (checkdoc-create-error - "Too many occurrences of \\[function]. Use \\{keymap} instead" + "Too many occurrences of \\[COMMAND]. Use \\{MAPVAR} instead" s (marker-position e))))) ;; Ambiguous quoted symbol. When a symbol is both bound and fbound, ;; and is referred to in documentation, it should be prefixed with -- 2.32.0.windows.1