[7.4.x] Improves clarity in Sphinx documentation for function signature.

This commit is contained in:
Arthur Richard 2023-12-14 12:14:36 +01:00 committed by pytest bot
parent 13024efd7a
commit 5d030b339f
3 changed files with 3 additions and 2 deletions

View File

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

View File

@ -79,7 +79,7 @@ pytest.xfail
pytest.exit pytest.exit
~~~~~~~~~~~ ~~~~~~~~~~~
.. autofunction:: pytest.exit(reason, [returncode=False, msg=None]) .. autofunction:: pytest.exit(reason, [returncode=None, msg=None])
pytest.main pytest.main
~~~~~~~~~~~ ~~~~~~~~~~~

View File

@ -123,7 +123,7 @@ def exit(
only because `msg` is deprecated. only because `msg` is deprecated.
:param returncode: :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: :param msg:
Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead. Same as ``reason``, but deprecated. Will be removed in a future version, use ``reason`` instead.