From 9007e16cdf791d3e9df45cd3f5a0c26fb551fac0 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Tue, 12 Jul 2016 12:41:40 -0300 Subject: [PATCH] Document limitations for yield-tests in nose Also add nose doc to the root toctree Closes #1716 --- doc/en/contents.rst | 1 + doc/en/nose.rst | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/en/contents.rst b/doc/en/contents.rst index 48c3471b5..4e94f4ade 100644 --- a/doc/en/contents.rst +++ b/doc/en/contents.rst @@ -19,6 +19,7 @@ Full pytest documentation recwarn cache plugins + nose contributing talks diff --git a/doc/en/nose.rst b/doc/en/nose.rst index 04386ea0f..fc2c4812e 100644 --- a/doc/en/nose.rst +++ b/doc/en/nose.rst @@ -24,7 +24,7 @@ Supported nose Idioms * setup and teardown at module/class/method level * SkipTest exceptions and markers * setup/teardown decorators -* yield-based tests and their setup +* ``yield``-based tests and their setup * ``__test__`` attribute on modules/classes/functions * general usage of nose utilities @@ -51,5 +51,12 @@ Unsupported idioms / known issues - nose-style doctests are not collected and executed correctly, also doctest fixtures don't work. -- no nose-configuration is recognized +- no nose-configuration is recognized. + +- ``yield``-based methods don't support ``setup`` properly because + the ``setup`` method is always called in the same class instance. + There are no plans to fix this currently because ``yield``-tests + are deprecated in pytest 3.0, with ``pytest.mark.parametrize`` + being the recommended alternative. +