[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 8477d3b: Make checkdoc's docstring substitution consistent with o
From: |
Eli Zaretskii |
Subject: |
master 8477d3b: Make checkdoc's docstring substitution consistent with other docs |
Date: |
Thu, 30 Sep 2021 12:25:46 -0400 (EDT) |
branch: master
commit 8477d3b339218cd2092728b55ef49c242b32b4ed
Author: Nikolay Kudryavtsev <nikolay.kudryavtsev@gmail.com>
Commit: Eli Zaretskii <eliz@gnu.org>
Make checkdoc's docstring substitution consistent with other docs
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
In error text, say "mapvar" instead of "keymap", and "command"
instead of "function", to be consistent with the ELisp manual.
(Bug#50903)
---
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 5ea2f59..e03ddc4 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -254,7 +254,7 @@ with these words enabled."
(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 @@ mouse-[0-3]\\)\\)\\>"))
(checkdoc-create-error
(concat
"Keycode " (match-string 1)
- " embedded in doc string. Use \\\\<keymap> & \\\\[function] "
+ " embedded in doc string. Use \\\\<mapvar> & \\\\[command] "
"instead")
(match-beginning 1) (match-end 1) t))))
;; Optionally warn about too many command substitutions.
@@ -1636,7 +1636,7 @@ mouse-[0-3]\\)\\)\\>"))
(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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 8477d3b: Make checkdoc's docstring substitution consistent with other docs,
Eli Zaretskii <=