Skip to content

Commit 5582bfc

Browse files
[7.4.x] Improves clarity in Sphinx documentation for function signature. (#11702)
Co-authored-by: Arthur Richard <[email protected]>
1 parent 13024ef commit 5582bfc

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

Diff for: AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Ariel Pillemer
4747
Armin Rigo
4848
Aron Coyle
4949
Aron Curzon
50+
Arthur Richard
5051
Ashish Kurmi
5152
Aviral Verma
5253
Aviv Palivoda

Diff for: doc/en/reference/reference.rst

+1-1
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
~~~~~~~~~~~

Diff for: src/_pytest/outcomes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ def exit(
123123
only because `msg` is deprecated.
124124
125125
:param returncode:
126-
Return code to be used when exiting pytest.
126+
Return code to be used when exiting pytest. None means the same as ``0`` (no error), same as :func:`sys.exit`.
127127
128128
:param msg:
129129
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.

0 commit comments

Comments
 (0)