Skip to content

Commit 15c202d

Browse files
authored
Merge pull request #3 from jbasko/dev
Docs
2 parents 0173fa1 + 99edda2 commit 15c202d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
pytest-random-order
22
===================================
33

4-
This is a **pytest** plugin to randomise the order in which tests are run with a little bit of control
4+
This is a pytest plugin **to randomise the order** in which tests are run **with some control**
55
over how much randomness one allows.
66

77
It is a good idea to randomise the order in which your tests run
88
because a test running early as part of a larger suite of tests may have left
99
the system under test in a particularly fortunate state for a subsequent test to pass.
1010

1111
How Random
12-
__________
12+
----------
1313

1414
**pytest-random-order** groups tests in buckets, shuffles them within buckets and then shuffles the buckets.
1515

16-
User can choose among four types of buckets to use:
16+
You can choose from four types of buckets:
1717

1818
* ``class``
19-
* ``module`` -- **this is the default setting**
19+
* ``module`` - **this is the default setting**
2020
* ``package``
21-
* ``global`` -- all tests fall in the same bucket, full randomness, tests probably take longer to run
21+
* ``global`` - all tests fall in the same bucket, full randomness, tests probably take longer to run
2222

2323
If you have three buckets of tests ``A``, ``B``, and ``C`` with three tests ``1`` and ``2``, and ``3`` in each of them,
2424
then here are just two of many potential orderings that non-global randomisation can produce:
@@ -33,8 +33,8 @@ As you can see, all C tests are executed "next" to each other and so are tests i
3333
Tests from any bucket X are guaranteed to not be interspersed with tests from another bucket Y.
3434
For example, if you choose bucket type ``module`` then bucket X contains all tests that are in this module.
3535

36-
Note that modules (and hence tests inside those modules) that belong to package ``x.y`` do not belong
37-
to package ``x.y.z``, so they will fall in different buckets when randomising with ``package`` bucket type.
36+
Note that modules (and hence tests inside those modules) that belong to package ``x.y.z`` do not belong
37+
to package ``x.y``, so they will fall in different buckets when randomising with ``package`` bucket type.
3838

3939
By default, your tests will be randomised at ``module`` level which means that
4040
tests within a single module X will be executed in no particular order, but tests from

0 commit comments

Comments
 (0)