Skip to content

Commit f3daf7f

Browse files
committed
Documentation details.
1 parent f3ee571 commit f3daf7f

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

doc/src/reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Reference
1111
for the test may be set in the depends argument.
1212

1313
:param name: the name of the test to be used for referencing by
14-
dependent tests. If not set, it defaults to the internal name
15-
used in pytest, that is the name of the test function,
14+
dependent tests. If not set, it defaults to the node ID
15+
defined by pytest, that is the name of the test function,
1616
extended by the parameters if applicable.
1717
:type name: :class:`str`
1818
:param depends: dependencies, a list of names of tests that this

doc/src/usage.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,12 @@ Naming tests
3838
------------
3939

4040
Tests are referenced by their name in the `depends` argument. The
41-
default for this name is the internal name used in pytest, that is the
41+
default for this name is the node ID defined by pytest, that is the
4242
name of the test function, extended by the parameters if applicable.
43-
As these names may become complicated, they can be overridden by an
44-
explicit `name` argument to the marker. The following example works
45-
exactly as the last one, only the test names are explicitely set:
43+
As these node IDs may become complicated, the name can be overridden
44+
by an explicit `name` argument to the marker. The following example
45+
works exactly as the last one, only the test names are explicitely
46+
set:
4647

4748
.. literalinclude:: ../examples/named.py
4849

pytest_dependency.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ def checkDepend(self, depends):
6565
def depends(request, other):
6666
"""Add dependency on other test.
6767
68-
Call pytest.skip() unless a successful outcome of all of the tests
69-
in other has been registered previously. This has the same effect
70-
as the `depends` keyword argument to the `dependency` marker. In
71-
contrast to the marker, this function may be called at runtime
72-
during a test.
68+
Call pytest.skip() unless a successful outcome of all of the tests in
69+
other has been registered previously. This has the same effect as
70+
the `depends` keyword argument to the :func:`pytest.mark.dependency`
71+
marker. In contrast to the marker, this function may be called at
72+
runtime during a test.
7373
7474
:param request: the value of the `request` pytest fixture related
7575
to the current test.

0 commit comments

Comments
 (0)