floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add sections to pytest's builtin API

This commit is contained in:
Bruno Oliveira 2018-02-26 20:34:53 -03:00
parent b53c4246ef
commit 44e2715529
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/en/reference.rst
View File

@ -9,23 +9,57 @@ This page contains the full reference to pytest's API.
:local: :local:
approx
------
.. autofunction:: _pytest.python_api.approx .. autofunction:: _pytest.python_api.approx
outcomes
--------
You can use the following functions in your test, fixture or setup You can use the following functions in your test, fixture or setup
functions to force a certain test outcome. Note that most often functions to force a certain test outcome. Note that most often
you can rather use declarative marks, see :ref:`skipping`. you can rather use declarative marks, see :ref:`skipping`.
fail
~~~~
.. autofunction:: _pytest.outcomes.fail .. autofunction:: _pytest.outcomes.fail
skip
~~~~
.. autofunction:: _pytest.outcomes.skip .. autofunction:: _pytest.outcomes.skip
importorskip
~~~~~~~~~~~~
.. autofunction:: _pytest.outcomes.importorskip .. autofunction:: _pytest.outcomes.importorskip
xfail
~~~~~
.. autofunction:: _pytest.outcomes.xfail .. autofunction:: _pytest.outcomes.xfail
exit
~~~~
.. autofunction:: _pytest.outcomes.exit .. autofunction:: _pytest.outcomes.exit
main
~~~~
.. autofunction:: _pytest.config.main .. autofunction:: _pytest.config.main
raises
------
.. autofunction:: _pytest.python_api.raises .. autofunction:: _pytest.python_api.raises
Examples at :ref:`assertraises`. Examples at :ref:`assertraises`.
deprecated_call
---------------
.. autofunction:: _pytest.recwarn.deprecated_call .. autofunction:: _pytest.recwarn.deprecated_call