Skip to content

Commit

Permalink
DOC: add info on docstrings in test functions/methods. Also fix a typo.
Browse files Browse the repository at this point in the history
  • Loading branch information
rgommers committed Jul 15, 2012
1 parent 4a2295d commit 675ce72
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/TESTS.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,11 @@ Sometimes it is convenient to run ``test_yyy.py`` by itself, so we add

at the bottom.

Note that ``test_`` functions or methods should not have a docstring, because

This comment has been minimized.

Copy link
@charris

charris Jul 15, 2012

I think this would go better if appended to the earlier paragraph that ends with -O.

This comment has been minimized.

Copy link
@rgommers

rgommers Jul 15, 2012

Author Owner

OK, I'll move it there and push the commit.

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.

Labeling tests with nose
------------------------

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::

Expand Down

2 comments on commit 675ce72

@charris
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like there is some janitorial work to be done, a lot of current tests have docstrings.

@rgommers
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, but it's not urgent. I'm just cleaning up when I run into some docstrings that are annoying. If they're unique, it's usually still possible to locate the failling test.

Please sign in to comment.