Browse files

DOC: add info on docstrings in test functions/methods. Also fix a typo.

Reviewed by @charris in combination with PR-358.
  • Loading branch information...
1 parent 4a2295d commit 4d371699a957b3f5c306ee0f5b8c2548c49338e5 @rgommers rgommers committed Jul 15, 2012
Showing with 7 additions and 2 deletions.
  1. +7 −2 doc/TESTS.rst.txt
@@ -107,6 +107,11 @@ whether a certain assumption is valid. If the assertion fails, the test fails.
Note that the Python builtin ``assert`` should not be used, because it is
stripped during compilation with ``-O``.
+Note that ``test_`` functions or methods should not have a docstring, because
+that makes it hard to identify the test from the output of running the test
+suite with ``verbose=2`` (or similar verbosity setting). Use plain comments
+(``#``) if necessary.
Sometimes it is convenient to run ```` by itself, so we add
@@ -174,7 +179,7 @@ nose decorators::
@nose.with_setup(setup_func, teardown_func)
def test_with_extras():
- """This test uses the setup/teardown functions."""
+ # This test uses the setup/teardown functions.
global helpful_variable
print " In test_with_extras"
print " Helpful is %s" % helpful_variable
@@ -205,7 +210,7 @@ hard to see for which parameters. To avoid this problem, ensure that:
``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.
+ - Those parameters are *not* arrays.
.. warning::

0 comments on commit 4d37169

Please sign in to comment.