Skip to content

Commit 047ba83

Browse files
authored
Improve pytest.exit docs (#11698)
Fixes #11695
1 parent 2b86d2b commit 047ba83

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Ariel Pillemer
4848
Armin Rigo
4949
Aron Coyle
5050
Aron Curzon
51+
Arthur Richard
5152
Ashish Kurmi
5253
Aviral Verma
5354
Aviv Palivoda

doc/en/reference/reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ pytest.xfail
7979
pytest.exit
8080
~~~~~~~~~~~
8181

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

8484
pytest.main
8585
~~~~~~~~~~~

src/_pytest/outcomes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ def exit(
112112
only because `msg` is deprecated.
113113
114114
:param returncode:
115-
Return code to be used when exiting pytest.
115+
Return code to be used when exiting pytest. None means the same as ``0`` (no error), same as :func:`sys.exit`.
116116
117117
:param msg:
118118
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.

0 commit comments

Comments
 (0)