p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/reference: refer to function public names instead of internal _pytest names 

This way e.g. a :py:func:`pytest.exit` cross-reference works properly.
This commit is contained in:
Ran Benita 2020-06-14 16:52:09 +03:00
parent 314d00968a
commit 5e35c86a37
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/en/changelog.rst
View File

@ -287,7 +287,7 @@ Bug Fixes
- `#6646 <https://github.com/pytest-dev/pytest/issues/6646>`_: Assertion rewriting hooks are (re)stored for the current item, which fixes them being still used after e.g. pytester's :func:`testdir.runpytest <_pytest.pytester.Testdir.runpytest>` etc. - `#6646 <https://github.com/pytest-dev/pytest/issues/6646>`_: Assertion rewriting hooks are (re)stored for the current item, which fixes them being still used after e.g. pytester's :func:`testdir.runpytest <_pytest.pytester.Testdir.runpytest>` etc.
- `#6660 <https://github.com/pytest-dev/pytest/issues/6660>`_: :func:`pytest.exit() <_pytest.outcomes.exit>` is handled when emitted from the :func:`pytest_sessionfinish <_pytest.hookspec.pytest_sessionfinish>` hook. This includes quitting from a debugger. - `#6660 <https://github.com/pytest-dev/pytest/issues/6660>`_: :py:func:`pytest.exit` is handled when emitted from the :func:`pytest_sessionfinish <_pytest.hookspec.pytest_sessionfinish>` hook. This includes quitting from a debugger.
- `#6752 <https://github.com/pytest-dev/pytest/issues/6752>`_: When :py:func:`pytest.raises` is used as a function (as opposed to a context manager), - `#6752 <https://github.com/pytest-dev/pytest/issues/6752>`_: When :py:func:`pytest.raises` is used as a function (as opposed to a context manager),
@ -399,7 +399,7 @@ Improvements
- `#6231 <https://github.com/pytest-dev/pytest/issues/6231>`_: Improve check for misspelling of :ref:`pytest.mark.parametrize ref`. - `#6231 <https://github.com/pytest-dev/pytest/issues/6231>`_: Improve check for misspelling of :ref:`pytest.mark.parametrize ref`.
- `#6257 <https://github.com/pytest-dev/pytest/issues/6257>`_: Handle :py:func:`_pytest.outcomes.exit` being used via :py:func:`~_pytest.hookspec.pytest_internalerror`, e.g. when quitting pdb from post mortem. - `#6257 <https://github.com/pytest-dev/pytest/issues/6257>`_: Handle :py:func:`pytest.exit` being used via :py:func:`~_pytest.hookspec.pytest_internalerror`, e.g. when quitting pdb from post mortem.

14
doc/en/reference.rst
View File

@ -15,41 +15,41 @@ Functions
pytest.approx pytest.approx
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. autofunction:: _pytest.python_api.approx .. autofunction:: pytest.approx
pytest.fail pytest.fail
~~~~~~~~~~~ ~~~~~~~~~~~
**Tutorial**: :ref:`skipping` **Tutorial**: :ref:`skipping`
.. autofunction:: _pytest.outcomes.fail .. autofunction:: pytest.fail
pytest.skip pytest.skip
~~~~~~~~~~~ ~~~~~~~~~~~
.. autofunction:: _pytest.outcomes.skip(msg, [allow_module_level=False]) .. autofunction:: pytest.skip(msg, [allow_module_level=False])
.. _`pytest.importorskip ref`: .. _`pytest.importorskip ref`:
pytest.importorskip pytest.importorskip
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
.. autofunction:: _pytest.outcomes.importorskip .. autofunction:: pytest.importorskip
pytest.xfail pytest.xfail
~~~~~~~~~~~~ ~~~~~~~~~~~~
.. autofunction:: _pytest.outcomes.xfail .. autofunction:: pytest.xfail
pytest.exit pytest.exit
~~~~~~~~~~~ ~~~~~~~~~~~
.. autofunction:: _pytest.outcomes.exit .. autofunction:: pytest.exit
pytest.main pytest.main
~~~~~~~~~~~ ~~~~~~~~~~~
.. autofunction:: _pytest.config.main .. autofunction:: pytest.main
pytest.param pytest.param
~~~~~~~~~~~~ ~~~~~~~~~~~~