Skip to content

Commit dd53cf5

Browse files
authored
Merge pull request #6 from jbasko/dev
Docs
2 parents d949e4f + 8f777c7 commit dd53cf5

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,21 @@ How?
2121

2222
You can choose from four types of buckets:
2323

24-
``class``
24+
class
25+
Tests from one class will never have tests from other classes or modules run in-between them.
2526

26-
``module``
27-
the default setting
27+
module
28+
Tests will be shuffled within a module and modules will be shuffled, but tests from one module
29+
will never be separated by tests from other modules.
30+
**This is the default setting**.
2831

29-
``package``
32+
package
33+
Same as above, but for package level. Note that modules (and hence tests inside those modules) that
34+
belong to package ``x.y.z`` do not belong to package ``x.y``, so they will fall in different buckets
35+
when randomising with ``package`` bucket type.
3036

31-
``global``
32-
all tests fall in the same bucket, full randomness, tests probably take longer to run
37+
global
38+
All tests fall in the same bucket, full randomness, tests probably take longer to run.
3339

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

47-
Note that modules (and hence tests inside those modules) that belong to package ``x.y.z`` do not belong
48-
to package ``x.y``, so they will fall in different buckets when randomising with ``package`` bucket type.
49-
5053
By default, your tests will be randomised at ``module`` level which means that
5154
tests within a single module X will be executed in no particular order, but tests from
5255
other modules will not be mixed in between tests of module X.

0 commit comments

Comments
 (0)