Skip to content

Docs: align pytest.mark.xfail and skip parameter signatures with reality (#10094) #14725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Joosboy wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

Docs: align pytest.mark.xfail and skip parameter signatures with reality (#10094) #14725

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/en/reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ pytest.mark.skip

Unconditionally skip a test function.

.. py:function:: pytest.mark.skip(reason=None)
.. py:function:: pytest.mark.skip(reason="unconditional skip")

:keyword str reason: Reason why the test function is being skipped.

Expand Down Expand Up @@ -266,7 +266,7 @@ pytest.mark.xfail

Marks a test function as *expected to fail*.

.. py:function:: pytest.mark.xfail(condition=False, *, reason=None, raises=None, run=True, strict=strict_xfail)
.. py:function:: pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=strict_xfail)

:keyword Union[bool, str] condition:
Condition for marking the test function as xfail (``True/False`` or a
Expand All @@ -277,7 +277,7 @@ Marks a test function as *expected to fail*.
:keyword raises:
Exception class (or tuple of classes) expected to be raised by the test function; other exceptions will fail the test.
Note that subclasses of the classes passed will also result in a match (similar to how the ``except`` statement works).
:type raises: Type[:py:exc:`Exception`]
:type raises: Type[:py:exc:`Exception`] | Tuple[Type[:py:exc:`Exception`], ...] | None

:keyword bool run:
Whether the test function should actually be executed. If ``False``, the function will always xfail and will
Expand Down