Improve pytest.exit docs (#11698)

Fixes #11695
pytest-dev · Dec 14, 2023 · 047ba83 · 047ba83
1 parent 2b86d2b
commit 047ba83
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -48,6 +48,7 @@ Ariel Pillemer
 Armin Rigo
 Aron Coyle
 Aron Curzon
+Arthur Richard
 Ashish Kurmi
 Aviral Verma
 Aviv Palivoda

diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst
@@ -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
 ~~~~~~~~~~~

diff --git a/src/_pytest/outcomes.py b/src/_pytest/outcomes.py
@@ -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.