diff options
| author | Denis Laxalde <denis@laxalde.org> | 2012-05-10 13:42:47 -0400 |
|---|---|---|
| committer | Denis Laxalde <denis@laxalde.org> | 2012-05-10 13:42:47 -0400 |
| commit | 8669d3f7f6aa463ff8b2fb787e06063259b8fa0f (patch) | |
| tree | c9d92f1907f3936c8506e072bb834ea7d9ac1083 /doc | |
| parent | bb162a291b765a34a2e6fab845c36f34c01357af (diff) | |
| download | numpy-8669d3f7f6aa463ff8b2fb787e06063259b8fa0f.tar.gz | |
DOC: verbosity -> verbose in testing guidelines
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/TESTS.rst.txt | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/TESTS.rst.txt b/doc/TESTS.rst.txt index a6387d7b2..9bde1849f 100644 --- a/doc/TESTS.rst.txt +++ b/doc/TESTS.rst.txt @@ -41,18 +41,18 @@ follows:: >>> import numpy >>> numpy.test() -The test method may take two or more arguments; the first is a string -label specifying what should be tested and the second is an integer -giving the level of output verbosity. See the docstring for numpy.test -for details. The default value for the label is 'fast' - which will -run the standard tests. The string 'full' will run the full battery -of tests, including those identified as being slow to run. If the -verbosity is 1 or less, the tests will just show information messages -about the tests that are run; but if it is greater than 1, then the -tests will also provide warnings on missing tests. So if you want to -run every test and get messages about which modules don't have tests:: - - >>> scipy.test(label='full', verbosity=2) # or scipy.test('full', 2) +The test method may take two or more arguments; the first, ``label`` is a +string specifying what should be tested and the second, ``verbose`` is an +integer giving the level of output verbosity. See the docstring for +numpy.test for details. The default value for ``label`` is 'fast' - which +will run the standard tests. The string 'full' will run the full battery +of tests, including those identified as being slow to run. If ``verbose`` +is 1 or less, the tests will just show information messages about the tests +that are run; but if it is greater than 1, then the tests will also provide +warnings on missing tests. So if you want to run every test and get +messages about which modules don't have tests:: + + >>> scipy.test(label='full', verbose=2) # or scipy.test('full', 2) Finally, if you are only interested in testing a subset of SciPy, for example, the ``integrate`` module, use the following:: @@ -357,6 +357,6 @@ failure by passing ``True`` as the first argument to ``skipif`` or A total of the number of skipped and known failing tests is displayed at the end of the test run. Skipped tests are marked as ``'S'`` in -the test results (or ``'SKIPPED'`` for ``verbosity > 1``), and known -failing tests are marked as ``'K'`` (or ``'KNOWN'`` if ``verbosity > +the test results (or ``'SKIPPED'`` for ``verbose > 1``), and known +failing tests are marked as ``'K'`` (or ``'KNOWN'`` if ``verbose > 1``). |