diff options
| author | endolith <endolith@gmail.com> | 2013-07-25 09:48:32 -0400 |
|---|---|---|
| committer | endolith <endolith@gmail.com> | 2013-07-25 09:48:32 -0400 |
| commit | 1eea247484093073389032da7cc72126e502ebaa (patch) | |
| tree | 5f6e3cda0d16b0ecfbf3d1817d698e390489ceaa | |
| parent | 756dad2846b3ae531e6ebd94b6c0fe89b48f25c6 (diff) | |
| download | numpy-1eea247484093073389032da7cc72126e502ebaa.tar.gz | |
DOC:Some minor proofreading of Tests introduction
| -rw-r--r-- | doc/TESTS.rst.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/TESTS.rst.txt b/doc/TESTS.rst.txt index 92f236f5a..dba035422 100644 --- a/doc/TESTS.rst.txt +++ b/doc/TESTS.rst.txt @@ -68,7 +68,7 @@ you'd like to become part of SciPy, please write the tests as you develop the package. Also since much of SciPy is legacy code that was originally written without unit tests, there are still several modules that don't have tests yet. Please feel free to choose one of these -modules to develop test for either after or even as you read through +modules and develop tests for it as you read through this introduction. Writing your own tests @@ -104,7 +104,7 @@ a test class:: Within these test methods, ``assert_()`` and related functions are used to test 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 +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 @@ -199,9 +199,9 @@ with test generators:: for i in range(0,4,2): yield check_even, i, i*3 -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. +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: @@ -220,7 +220,7 @@ hard to see for which parameters. To avoid this problem, ensure that: Doctests -------- -Doctests are a convenient way of documenting the behavior a function +Doctests are a convenient way of documenting the behavior of a function and allowing that behavior to be tested at the same time. The output of an interactive Python session can be included in the docstring of a function, and the test framework can run the example and compare the |