summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/TESTS.rst.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/TESTS.rst.txt b/doc/TESTS.rst.txt
index 9bde1849f..8f8da8c18 100644
--- a/doc/TESTS.rst.txt
+++ b/doc/TESTS.rst.txt
@@ -198,6 +198,15 @@ Note that 'check_even' is not itself a test (no 'test' in the name),
but 'test_evens' is a generator that returns a series of tests, using
'check_even', across a range of inputs.
+A problem with generator tests can be that if a test is failing, it's
+hard to see for which parameters. To avoid this problem, ensure that:
+
+ - No computation related to the features tested is done in the
+ ``test_*`` generator function, but delegated to a corresponding
+ ``check_*`` function (can be inside the generator, to share namespace).
+ - The generators are used *solely* for loops over parameters.
+ - These parameters are *not* arrays.
+
.. warning::
Parametric tests cannot be implemented on classes derived from