Skip to content

Commit f9fa920

Browse files
[3.9] bpo-38320: Clarify that expectedFailure is satisfied by either failure or error of the test. (GH-22740) (GH-22783)
(cherry picked from commit fa87482) Co-authored-by: Irit Katriel <[email protected]>
1 parent 37f6fe2 commit f9fa920

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Doc/library/unittest.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -593,8 +593,9 @@ The following decorators and exception implement test skipping and expected fail
593593

594594
.. decorator:: expectedFailure
595595

596-
Mark the test as an expected failure. If the test fails it will be
597-
considered a success. If the test passes, it will be considered a failure.
596+
Mark the test as an expected failure or error. If the test fails or errors
597+
it will be considered a success. If the test passes, it will be considered
598+
a failure.
598599

599600
.. exception:: SkipTest(reason)
600601

@@ -1946,7 +1947,7 @@ Loading and running tests
19461947

19471948
A list containing 2-tuples of :class:`TestCase` instances and strings
19481949
holding formatted tracebacks. Each tuple represents an expected failure
1949-
of the test case.
1950+
or error of the test case.
19501951

19511952
.. attribute:: unexpectedSuccesses
19521953

@@ -2072,8 +2073,8 @@ Loading and running tests
20722073

20732074
.. method:: addExpectedFailure(test, err)
20742075

2075-
Called when the test case *test* fails, but was marked with the
2076-
:func:`expectedFailure` decorator.
2076+
Called when the test case *test* fails or errors, but was marked with
2077+
the :func:`expectedFailure` decorator.
20772078

20782079
The default implementation appends a tuple ``(test, formatted_err)`` to
20792080
the instance's :attr:`expectedFailures` attribute, where *formatted_err*

0 commit comments

Comments
 (0)