aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lisp/emacs-lisp/ert.el27
1 files changed, 17 insertions, 10 deletions
diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el
index 02551bad31f..731e8d1a40a 100644
--- a/lisp/emacs-lisp/ert.el
+++ b/lisp/emacs-lisp/ert.el
@@ -422,16 +422,23 @@ and aborts the current test as failed if it doesn't."
422(cl-defmacro should-error (form &rest keys &key type exclude-subtypes) 422(cl-defmacro should-error (form &rest keys &key type exclude-subtypes)
423 "Evaluate FORM and check that it signals an error. 423 "Evaluate FORM and check that it signals an error.
424 424
425The error signaled needs to match TYPE. TYPE should be a list 425If no error was signaled, abort the test as failed and
426of condition names. (It can also be a non-nil symbol, which is 426return (ERROR-SYMBOL . DATA) from the error.
427equivalent to a singleton list containing that symbol.) If 427
428EXCLUDE-SUBTYPES is nil, the error matches TYPE if one of its 428You can also match specific errors using the KEYWORD-ARGS arguments,
429condition names is an element of TYPE. If EXCLUDE-SUBTYPES is 429which is specified as keyword/argument pairs. The following arguments
430non-nil, the error matches TYPE if it is an element of TYPE. 430are defined:
431 431
432If the error matches, returns (ERROR-SYMBOL . DATA) from the 432:type TYPE -- If TYPE is non-nil, the error signaled needs to match
433error. If not, or if no error was signaled, abort the test as 433TYPE. TYPE should be a list of condition names. It can also be a
434failed." 434symbol, which is equivalent to a one-element list containing that
435symbol.
436
437:exclude-subtypes EXCLUDED -- If EXCLUDED is non-nil, the error matches
438TYPE only if it is an element of TYPE. If nil (the default), the error
439matches TYPE if one of its condition names is an element of TYPE.
440
441\(fn FORM &rest KEYWORD-ARGS)"
435 (declare (debug t)) 442 (declare (debug t))
436 (unless type (setq type ''error)) 443 (unless type (setq type ''error))
437 (ert--expand-should 444 (ert--expand-should