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

checkdoc CL tests

Browse source 
* test/lisp/emacs-lisp/checkdoc-tests.el: Add cl-lib-related tests
(bug#37063).
This commit is contained in:
Damien Cassou 2019-10-10 02:19:10 +02:00 • committed by Lars Ingebrigtsen
parent b9211d0bc2
commit 46d11bcfa3
1 changed files with 106 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -37,6 +37,112 @@
(insert "(defun foo())")
(should-error (checkdoc-defun) :type 'user-error)))
(ert-deftest checkdoc-cl-defmethod-ok ()
"Checkdoc should be happy with a simple correct cl-defmethod."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defmethod foo (a) \"Return A.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defmethod-with-types-ok ()
"Checkdoc should be happy with a cl-defmethod using types."
(with-temp-buffer
(emacs-lisp-mode)
;; this method matches if A is the symbol `smthg' and if b is a list:
(insert "(cl-defmethod foo ((a (eql smthg)) (b list)) \"Return A+B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-key-ok ()
"Checkdoc should be happy with a cl-defun using &key."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo (&key a (b 27)) \"Return :A+:B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-allow-other-keys-ok ()
"Checkdoc should be happy with a cl-defun using &allow-other-keys."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo (&key a &allow-other-keys) \"Return :A.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-default-optional-value-ok ()
"Checkdoc should be happy with a cl-defun using default values for optional args."
(with-temp-buffer
(emacs-lisp-mode)
;; B is optional and equals 1+a if not provided. HAS-BS is non-nil
;; if B was provided in the call:
(insert "(cl-defun foo (a &optional (b (1+ a) has-bs)) \"Return A + B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-destructuring-ok ()
"Checkdoc should be happy with a cl-defun destructuring its arguments."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo ((a b &optional c) d) \"Return A+B+C+D.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defmethod-ok ()
"Checkdoc should be happy with a simple correct cl-defmethod."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defmethod foo (a) \"Return A.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defmethod-with-types-ok ()
"Checkdoc should be happy with a cl-defmethod using types."
(with-temp-buffer
(emacs-lisp-mode)
;; this method matches if A is the symbol `smthg' and if b is a list:
(insert "(cl-defmethod foo ((a (eql smthg)) (b list)) \"Return A+B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-key-ok ()
"Checkdoc should be happy with a cl-defun using &key."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo (&key a (b 27)) \"Return :A+:B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-allow-other-keys-ok ()
"Checkdoc should be happy with a cl-defun using &allow-other-keys."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo (&key a &allow-other-keys) \"Return :A.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-aux-ok ()
"Checkdoc should be happy with a cl-defun using &aux."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo (a b &aux (c (+ a b))) \"Return A and B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-default-optional-value-ok ()
"Checkdoc should be happy with a cl-defun using default values for optional args."
(with-temp-buffer
(emacs-lisp-mode)
;; B is optional and equals 1+a if not provided. HAS-BS is non-nil
;; if B was provided in the call:
(insert "(cl-defun foo (a &optional (b (1+ a) has-bs)) \"Return A + B.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defun-with-destructuring-ok ()
"Checkdoc should be happy with a cl-defun destructuring its arguments."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(cl-defun foo ((a b &optional c) d) \"Return A+B+C+D.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-cl-defmethod-with-context-ok ()
"Checkdoc should ignore context specializers in a cl-defmethod."
(with-temp-buffer
(emacs-lisp-mode)
;; A context specializer is used to select the correct method but
;; doesn't have to appear in the docstring:
(insert "(cl-defmethod foo (a &context (global-var (eql foo))) \"Return A.\")")
(checkdoc-defun)))
(ert-deftest checkdoc-tests--next-docstring ()
"Checks that the one-argument form of `defvar' works.
See the comments in Bug#24998."