From 44e2715529e7e715c0f778011fe0b68327cd34e6 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Mon, 26 Feb 2018 20:34:53 -0300 Subject: [PATCH] Add sections to pytest's builtin API --- doc/en/reference.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/en/reference.rst b/doc/en/reference.rst index 92d69d95b..e4192f430 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -9,23 +9,57 @@ This page contains the full reference to pytest's API. :local: +approx +------ + .. autofunction:: _pytest.python_api.approx +outcomes +-------- + You can use the following functions in your test, fixture or setup functions to force a certain test outcome. Note that most often you can rather use declarative marks, see :ref:`skipping`. +fail +~~~~ + .. autofunction:: _pytest.outcomes.fail + +skip +~~~~ + .. autofunction:: _pytest.outcomes.skip + +importorskip +~~~~~~~~~~~~ + .. autofunction:: _pytest.outcomes.importorskip + +xfail +~~~~~ + .. autofunction:: _pytest.outcomes.xfail + +exit +~~~~ + .. autofunction:: _pytest.outcomes.exit + +main +~~~~ + .. autofunction:: _pytest.config.main +raises +------ .. autofunction:: _pytest.python_api.raises Examples at :ref:`assertraises`. +deprecated_call +--------------- + .. autofunction:: _pytest.recwarn.deprecated_call