Skip to content

Commit ac6369f

Browse files
committed
Merge branch 'doc'
2 parents d7ce934 + 3cc2d1a commit ac6369f

File tree

5 files changed

+16
-5
lines changed

5 files changed

+16
-5
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The directory doc/html in the source distribution contains the
6666
documentation in HTML form generated by Sphinx. The starting point is
6767
doc/html/index.html. The documentation can also be found online at
6868

69-
http://pythonhosted.org/pytest-dependency/
69+
https://pytest-dependency.readthedocs.io/
7070

7171
The example test modules used in the documentation can be found in
7272
doc/examples in the source distribution.

doc/src/advanced.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ fixture on its own. Consider:
5252
In this example, both `test_b[7]` and `test_c[7]` are skipped, because
5353
`test_a[7]` deliberately fails.
5454

55-
.. __: https://docs.pytest.org/en/latest/fixture.html#automatic-grouping-of-tests-by-fixture-instances
55+
.. __: https://docs.pytest.org/en/stable/fixture.html#automatic-grouping-of-tests-by-fixture-instances
5656

5757
Depend on all instances of a parametrized test at once
5858
------------------------------------------------------

doc/src/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ automark_dependency
3434
has the same effect as if all tests are implicitly decorated with
3535
:func:`pytest.mark.dependency`.
3636

37+
.. versionadded:: 0.3
38+
3739
Command line options
3840
--------------------
3941

@@ -48,3 +50,5 @@ The following command line options are added by pytest.dependency:
4850
This may be useful if you run only a subset of the testsuite and
4951
some tests in the selected set are marked to depend on other tests
5052
that have not been selected.
53+
54+
.. versionadded:: 0.3

doc/src/reference.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Reference
1313
:param name: the name of the test to be used for referencing by
1414
dependent tests. If not set, it defaults to the node ID
1515
defined by pytest, that is the name of the test function,
16-
extended by the parameters if applicable.
16+
extended by the parameters if applicable. The name must be
17+
unique in the scope, which is currently the test module.
1718
:type name: :class:`str`
1819
:param depends: dependencies, a list of names of tests that this
1920
test depends on. The test will be skipped unless all of the

doc/src/usage.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ default for this name is the node ID defined by pytest, that is the
4646
name of the test function, extended by the parameters if applicable.
4747
In some cases, it's not easy to predict the names of the node IDs.
4848
For this reason, the name of the tests can be overridden by an
49-
explicit `name` argument to the marker. The following example works
50-
exactly as the last one, only the test names are explicitely set:
49+
explicit `name` argument to the marker. The names must be unique in
50+
the scope, which is currently the test module. The following example
51+
works exactly as the last one, only the test names are explicitely
52+
set:
5153

5254
.. literalinclude:: ../examples/named.py
5355

@@ -66,6 +68,10 @@ build from the name of the class and the respective method in this
6668
case, while in `TestClassNamed` these names are overridden by an
6769
explicit name argument to the :func:`pytest.mark.dependency` marker.
6870

71+
.. versionchanged:: 0.3
72+
The name of the class is prepended to method name to form the
73+
default name for the test.
74+
6975
.. _usage-parametrized:
7076

7177
Parametrized tests

0 commit comments

Comments
 (0)