Skip to content

Commit d0f41dc

Browse files
committed
Add a section to the README about --max-examples
1 parent 9fbe990 commit d0f41dc

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,20 @@ import numpy as array_module
6464
difficult to actually test, so they are not covered in the test suite (TODO:
6565
list what these are).
6666

67+
## Configuring Tests
68+
69+
The tests make heavy use of the
70+
[Hypothesis](https://hypothesis.readthedocs.io/en/latest/) testing library.
71+
Hypothesis generates random input values for the tests. You can configure how
72+
many values are generated and run using the `--max-examples` flag. The default
73+
`--max-examples` is 100. For example, `--max-examples 50` will only generate
74+
half as many examples and as a result, the test suite will run in about half
75+
the time. Setting `--max-examples` to a lower value can be useful when you
76+
want to have a faster test run. It can also be useful to set `--max-examples`
77+
to a large value to do a longer, more rigorous run of the tests. For example,
78+
`--max-examples 10000` will do a very rigorous check of the tests, but may
79+
take a few hours to run.
80+
6781
## Contributing
6882

6983
### Adding Tests

0 commit comments

Comments
 (0)