diff --git a/docs/source/testing.rst b/docs/source/testing.rst index f5d4e74dfa54756a4d206abf60fa1ef35d03eaa5..1fe478b1477e05fac4c4744e87c3d0f9ac0d5666 100644 --- a/docs/source/testing.rst +++ b/docs/source/testing.rst @@ -67,7 +67,7 @@ for each affected test individually:: replacing `test_XXX.py` with the test you'd like to run. This will execute the notebook, create artefact entries in the artefact -dir, and the check for consistency by executing the test against +dir, and after that will check for consistency by executing the test against these artefacts. This last part is important: the test should not fail on its own input. If it does, something is very likely wrong! @@ -82,8 +82,8 @@ changed. .. note:: - Reviewers should always question if a change in test artefacts - is appropriate and intended. + Reviewers should always evaluate if the changes in test artefacts are + appropriate, intended and acceptable. Test Reports ++++++++++++ @@ -94,7 +94,7 @@ directory. .. note:: - Please make sure to not commit any additional files into the + Please make sure not to commit any additional files into the `test_rsts subfolder` of this documentation. Also, do not commit `test_results.rst`. It is autogenerated.