Skip to content

Commit 2fa78f1

Browse files
committed
Fix reStructuredText markup. Some formulations.
1 parent 62dfdeb commit 2fa78f1

File tree

2 files changed

+30
-27
lines changed

2 files changed

+30
-27
lines changed

doc/src/configuration.rst

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,32 @@ Configuration file options
1010

1111
Configuration file options can be set in the `ini file`.
1212

13-
minversion
14-
This is a builtin configuration option of pytest itself. Since
15-
pytest-dependency requires pytest 2.8.0 or newer, it is
16-
recommended to set this option accordingly.
17-
18-
automark_dependency
19-
This is a flag. If set to `False`, the default, the outcome of
20-
a test will only be registered if the test has been decorated
21-
with the :func:`pytest.mark.dependency` marker. As a results,
22-
all tests, the dependencies and the dependent tests must be
23-
decorated. If set to `True`, the outcome of all tests will be
24-
registered. It has the same effect as if all tests are
25-
implicitly decorated with :func:`pytest.mark.dependency`.
13+
minversion
14+
This is a builtin configuration option of pytest itself. Since
15+
pytest-dependency requires pytest 2.8.0 or newer, it is recommended
16+
to set this option accordingly, either to 2.8.0 or to a newer
17+
version, if required by your test code.
18+
19+
automark_dependency
20+
This is a flag. If set to `False`, the default, the outcome of a
21+
test will only be registered if the test has been decorated with
22+
the :func:`pytest.mark.dependency` marker. As a results, all
23+
tests, the dependencies and the dependent tests must be decorated.
24+
If set to `True`, the outcome of all tests will be registered. It
25+
has the same effect as if all tests are implicitly decorated with
26+
:func:`pytest.mark.dependency`.
2627

2728
Command line options
2829
--------------------
2930

3031
The following command line options are added by pytest.dependency:
3132

32-
`--ignore-unknown-dependency`
33-
By default, a test will be skipped unless all the dependencies
34-
have been run successful. If this option is set, a test will be
35-
skipped if any of the dependencies has been skipped or failed.
36-
E.g. dependencies that have not been run at all will be ignored.
33+
`--ignore-unknown-dependency`
34+
By default, a test will be skipped unless all the dependencies have
35+
been run successful. If this option is set, a test will be skipped
36+
if any of the dependencies has been skipped or failed.
37+
E.g. dependencies that have not been run at all will be ignored.
3738

38-
This may be useful if you run only a subset of the testsuite and
39-
some tests in the selected set are marked to depend on other
40-
tests that have not been selected.
39+
This may be useful if you run only a subset of the testsuite and
40+
some tests in the selected set are marked to depend on other tests
41+
that have not been selected.

doc/src/install.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@ System requirements
1515
Interaction with other packages
1616
-------------------------------
1717

18-
pytest-xdist
19-
pytest-xdist features test run parallelization,
20-
e.g. distributing tests over separate processes that run in
21-
parallel. This is based on the assumption that the tests can be
22-
run independent of each other. pytest-dependency will only work
23-
if you disable parallelization in pytest-xdist.
18+
pytest-xdist
19+
pytest-xdist features test run parallelization, e.g. distributing
20+
tests over separate processes that run in parallel. This is based
21+
on the assumption that the tests can be run independent of each
22+
other. Obviously, if you are using pytest-dependency, this
23+
assumption is not valid. Thus, pytest-dependency will only work if
24+
you do not enable parallelization in pytest-xdist.
25+
2426

2527
Download
2628
--------

0 commit comments

Comments
 (0)