Skip to content

Commit

Permalink
[7.4.x] Improves clarity in Sphinx documentation for function signatu…
Browse files Browse the repository at this point in the history
…re. (#11702)

Co-authored-by: Arthur Richard <arthur.richard2299@gmail.com>
  • Loading branch information
github-actions[bot] and arthuRHD authored Dec 14, 2023
1 parent 13024ef commit 5582bfc
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Ariel Pillemer
Armin Rigo
Aron Coyle
Aron Curzon
Arthur Richard
Ashish Kurmi
Aviral Verma
Aviv Palivoda
Expand Down
2 changes: 1 addition & 1 deletion doc/en/reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ pytest.xfail
pytest.exit
~~~~~~~~~~~

.. autofunction:: pytest.exit(reason, [returncode=False, msg=None])
.. autofunction:: pytest.exit(reason, [returncode=None, msg=None])

pytest.main
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion src/_pytest/outcomes.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def exit(
only because `msg` is deprecated.
:param returncode:
Return code to be used when exiting pytest.
Return code to be used when exiting pytest. None means the same as ``0`` (no error), same as :func:`sys.exit`.
:param msg:
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.
Expand Down

0 comments on commit 5582bfc

Please sign in to comment.