mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Improve docstring of should-error

Browse source 
* lisp/emacs-lisp/ert.el (should-error): Improve docstring.
This commit is contained in:
Stefan Kangas 2025-03-23 17:40:22 +01:00
parent c6a11128d5
commit c2c287b325
1 changed files with 16 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

25
lisp/emacs-lisp/ert.el
View file

@ -422,16 +422,23 @@ and aborts the current test as failed if it doesn't."
(cl-defmacro should-error (form &rest keys &key type exclude-subtypes) (cl-defmacro should-error (form &rest keys &key type exclude-subtypes)
"Evaluate FORM and check that it signals an error. "Evaluate FORM and check that it signals an error.
The error signaled needs to match TYPE. TYPE should be a list If no error was signaled, abort the test as failed and
of condition names. (It can also be a non-nil symbol, which is return (ERROR-SYMBOL . DATA) from the error.
equivalent to a singleton list containing that symbol.) If
EXCLUDE-SUBTYPES is nil, the error matches TYPE if one of its
condition names is an element of TYPE. If EXCLUDE-SUBTYPES is
non-nil, the error matches TYPE if it is an element of TYPE.
If the error matches, returns (ERROR-SYMBOL . DATA) from the You can also match specific errors using the KEYWORD-ARGS arguments,
error. If not, or if no error was signaled, abort the test as which is specified as keyword/argument pairs. The following arguments
failed." are defined:
:type TYPE -- If TYPE is non-nil, the error signaled needs to match
TYPE. TYPE should be a list of condition names. It can also be a
symbol, which is equivalent to a one-element list containing that
symbol.
:exclude-subtypes EXCLUDED -- If EXCLUDED is non-nil, the error matches
TYPE only if it is an element of TYPE. If nil (the default), the error
matches TYPE if one of its condition names is an element of TYPE.
\(fn FORM &rest KEYWORD-ARGS)"
(declare (debug t)) (declare (debug t))
(unless type (setq type ''error)) (unless type (setq type ''error))
(ert--expand-should (ert--expand-should