Skip to content

Commit 9007e16

Browse files
committed
Document limitations for yield-tests in nose
Also add nose doc to the root toctree Closes #1716
1 parent cc0920c commit 9007e16

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

doc/en/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Full pytest documentation
1919
recwarn
2020
cache
2121
plugins
22+
nose
2223

2324
contributing
2425
talks

doc/en/nose.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Supported nose Idioms
2424
* setup and teardown at module/class/method level
2525
* SkipTest exceptions and markers
2626
* setup/teardown decorators
27-
* yield-based tests and their setup
27+
* ``yield``-based tests and their setup
2828
* ``__test__`` attribute on modules/classes/functions
2929
* general usage of nose utilities
3030

@@ -51,5 +51,12 @@ Unsupported idioms / known issues
5151
- nose-style doctests are not collected and executed correctly,
5252
also doctest fixtures don't work.
5353

54-
- no nose-configuration is recognized
54+
- no nose-configuration is recognized.
55+
56+
- ``yield``-based methods don't support ``setup`` properly because
57+
the ``setup`` method is always called in the same class instance.
58+
There are no plans to fix this currently because ``yield``-tests
59+
are deprecated in pytest 3.0, with ``pytest.mark.parametrize``
60+
being the recommended alternative.
61+
5562

0 commit comments

Comments
 (0)