diff --git a/clintest/__init__.py b/clintest/__init__.py index 72ca1a7..f298177 100644 --- a/clintest/__init__.py +++ b/clintest/__init__.py @@ -18,7 +18,7 @@ A conda package is planned but currently not available. ### Using pip -The pip package is hosted at https://pypi.org/project/clintest. +The pip package is hosted at [https://pypi.org/project/clintest](https://pypi.org/project/clintest). It can be installed with ``` @@ -143,7 +143,8 @@ ### Debugging Understanding why a test has failed can be challenging if one has no insight into the interaction between the test and the solver. -This is where `clintest.test.Record`, a test that can be wrapped around any other test, comes in handy. +This is where `clintest.test.Record` comes in handy. +`clintest.test.Record` can be wrapped around any other test to save crucial information. ``` from clintest.test import Record @@ -183,13 +184,13 @@ ### Custom-build tests In case you are unable to assemble your test from the off-the-shelf components in `clintest`, you might consider to custom-build it. -Custom-build tests must, just as any other tests, extend `test.Test` in order to work with this library. +Custom-built tests must, just as any other tests, extend `test.Test` in order to work with this library. This includes implementing two methods though a third is often needed: -1. `test.Test.outcome()` may me called anytime and should return the current `outcome.Outcome` of your test. +1. `test.Test.outcome()` may be called anytime and should return the current `outcome.Outcome` of your test. Once the outcome is certain, it must not change anymore. 2. `test.Test.on_finish()` is called once solving comes to an end. -The call to this method is your last change to alter the outcome of your test. +The call to this method is your last chance to alter the outcome of your test. After the call, the outcome must be certain. 3. optional: `test.Test.on_model()` is called whenever a model is found. You may inspect the model to change the outcome of your test.