diff options
| author | Pierre de Buyl <pdebuyl@pdebuyl.be> | 2016-09-06 14:54:08 +0200 |
|---|---|---|
| committer | Pierre de Buyl <pdebuyl@pdebuyl.be> | 2016-09-06 14:54:08 +0200 |
| commit | 3f6672a30cd06d273e0b2160084a9abadcf9c315 (patch) | |
| tree | e5f283690c21b36dcb5d9d5a4e750dfa8d11efba /tools/c_coverage | |
| parent | 2a55233b81a6ea18a57d1dd4f7bc5fff9f2fb681 (diff) | |
| download | python-numpy-3f6672a30cd06d273e0b2160084a9abadcf9c315.tar.gz python-numpy-3f6672a30cd06d273e0b2160084a9abadcf9c315.tar.bz2 python-numpy-3f6672a30cd06d273e0b2160084a9abadcf9c315.zip | |
DOC: change Numpy to NumPy in remaining files
the files in doc/ and numpy/ were covered in previous commits
Diffstat (limited to 'tools/c_coverage')
| -rw-r--r-- | tools/c_coverage/HOWTO_C_COVERAGE.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/tools/c_coverage/HOWTO_C_COVERAGE.txt b/tools/c_coverage/HOWTO_C_COVERAGE.txt index 320d9b0de..8822dd715 100644 --- a/tools/c_coverage/HOWTO_C_COVERAGE.txt +++ b/tools/c_coverage/HOWTO_C_COVERAGE.txt @@ -27,7 +27,7 @@ For most cases, it is good enough to do:: > c_coverage_collect.sh python -c "import numpy; numpy.test()" > c_coverage_report.py callgrind.out.pid -which will run all of the Numpy unit tests, create a directory called +which will run all of the NumPy unit tests, create a directory called `coverage` and place the coverage results there. In a more advanced scenario, you may wish to run individual unit tests @@ -41,7 +41,7 @@ To collect coverage results, you merely run the python interpreter under valgrind's callgrind tool. The `c_coverage_collect.sh` helper script will pass all of the required arguments to valgrind. -For example, in typical usage, you may want to run all of the Numpy +For example, in typical usage, you may want to run all of the NumPy unit tests:: > c_coverage_collect.sh python -c "import numpy; numpy.test()" @@ -99,7 +99,7 @@ HTML reports The HTML report highlights the code that was run in green. The HTML report has special support for the "generated" functions in -Numpy. Each run line of code also contains a number in square +NumPy. Each run line of code also contains a number in square brackets indicating the number of different generated functions the line was run in. Hovering the mouse over the line will display a list of the versions of the function in which the line was run. These @@ -112,6 +112,6 @@ Caveats The coverage results occasionally misses lines that clearly must have been run. This usually can be traced back to the compiler optimizer removing lines because they are tautologically impossible or to -combine lines together. Compiling Numpy without optimizations helps, +combine lines together. Compiling NumPy without optimizations helps, but not completely. Even despite this flaw, this tool is still helpful in identifying large missed blocks or functions. |