Improve pytest.exit docs (#11698)

Fixes #11695
This commit is contained in:
Arthur Richard
2023-12-14 12:14:36 +01:00
committed by GitHub
parent 2b86d2bddc
commit 047ba83dab
3 changed files with 3 additions and 2 deletions

View File

@@ -48,6 +48,7 @@ Ariel Pillemer
Armin Rigo
Aron Coyle
Aron Curzon
Arthur Richard
Ashish Kurmi
Aviral Verma
Aviv Palivoda

View File

@@ -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
~~~~~~~~~~~

View File

@@ -112,7 +112,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.