Merge pull request #10054 from SnoopJeDi/doc/xfail-multiple-exceptions

Indicate support for a tuple of exceptions in xfail raises=
This commit is contained in:
Bruno Oliveira 2022-06-26 09:54:18 -03:00 committed by GitHub
commit 11fb5cd331
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions

View File

@ -245,7 +245,7 @@ Marks a test function as *expected to fail*.
:keyword str reason:
Reason why the test function is marked as xfail.
:keyword Type[Exception] raises:
Exception subclass expected to be raised by the test function; other exceptions will fail the test.
Exception subclass (or tuple of subclasses) expected to be raised by the test function; other exceptions will fail the test.
:keyword bool run:
If the test function should actually be executed. If ``False``, the function will always xfail and will
not be executed (useful if a function is segfaulting).