doc: fix a few pytest.mark.xfail nits

Refs #9027, #10094.
This commit is contained in:
Ran Benita
2023-08-12 18:02:13 +03:00
parent 556e075d23
commit 1827d8d5f9
3 changed files with 11 additions and 4 deletions

View File

@@ -461,7 +461,9 @@ if TYPE_CHECKING:
*conditions: Union[str, bool],
reason: str = ...,
run: bool = ...,
raises: Union[Type[BaseException], Tuple[Type[BaseException], ...]] = ...,
raises: Union[
None, Type[BaseException], Tuple[Type[BaseException], ...]
] = ...,
strict: bool = ...,
) -> MarkDecorator:
...

View File

@@ -233,6 +233,9 @@ def xfail(reason: str = "") -> NoReturn:
This function should be called only during testing (setup, call or teardown).
No other code is executed after using ``xfail()`` (it is implemented
internally by raising an exception).
:param reason:
The message to show the user as reason for the xfail.