procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

checkdoc: Allow Lisp symbols to start a message

Browse source 
* lisp/emacs-lisp/checkdoc.el (checkdoc-message-text-engine): Allow
Lisp symbols to start a message.
(checkdoc--error-bad-format-p): New helper function.

* test/lisp/emacs-lisp/checkdoc-tests.el
(checkdoc-test-error-format-is-good)
(checkdoc-test-error-format-is-bad): New helper functions.
(checkdoc-tests-error-message-bad-format-p)
(checkdoc-tests-error-message-bad-format-p/defined-symbols)
(checkdoc-tests-error-message-bad-format-p/not-capitalized):
New tests.
This commit is contained in:
Stefan Kangas 2021-09-26 01:20:55 +02:00
parent 6bec21243d
commit 3cabf64131
2 changed files with 67 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

37
test/lisp/emacs-lisp/checkdoc-tests.el
View file

@ -151,6 +151,43 @@ See the comments in Bug#24998."
(ert-deftest checkdoc-tests-in-abbrevation-p/incorrect-abbreviation ()
(should-not (checkdoc-tests--abbrev-test "foo bar a.b.c." "a.b.c")))
(defun checkdoc-test-error-format-is-good (msg &optional reverse literal)
(with-temp-buffer
(erase-buffer)
(emacs-lisp-mode)
(let ((standard-output (current-buffer)))
(if literal
(print (format "(error \"%s\")" msg))
(prin1 `(error ,msg))))
(goto-char (length "(error \""))
(if reverse
(should (checkdoc--error-bad-format-p))
(should-not (checkdoc--error-bad-format-p)))))
(defun checkdoc-test-error-format-is-bad (msg &optional literal)
(checkdoc-test-error-format-is-good msg t literal))
(ert-deftest checkdoc-tests-error-message-bad-format-p ()
(checkdoc-test-error-format-is-good "Foo")
(checkdoc-test-error-format-is-good "Foo: bar baz")
(checkdoc-test-error-format-is-good "some-symbol: Foo")
(checkdoc-test-error-format-is-good "`some-symbol' foo bar")
(checkdoc-test-error-format-is-good "%sfoo")
(checkdoc-test-error-format-is-good "avl-tree-enter:\\
Updated data does not match existing data" nil 'literal))
(ert-deftest checkdoc-tests-error-message-bad-format-p/defined-symbols ()
(defvar checkdoc-tests--var-symbol nil)
(checkdoc-test-error-format-is-good "checkdoc-tests--var-symbol foo bar baz")
(defun checkdoc-tests--fun-symbol ())
(checkdoc-test-error-format-is-good "checkdoc-tests--fun-symbol foo bar baz"))
(ert-deftest checkdoc-tests-error-message-bad-format-p/not-capitalized ()
(checkdoc-test-error-format-is-bad "foo")
(checkdoc-test-error-format-is-bad "some-symbol: foo")
(checkdoc-test-error-format-is-bad "avl-tree-enter:\
updated data does not match existing data"))
(ert-deftest checkdoc-tests-fix-y-or-n-p ()
(with-temp-buffer
(emacs-lisp-mode)