Fix the description of make coverage.

This commit is contained in:
Ralf Gommers
2009-11-02 20:43:09 +01:00
parent dd6b3ee576
commit 00cf3a841b
4 changed files with 45 additions and 39 deletions
+9 -3
View File
@@ -19,7 +19,7 @@ b.txt``) as well.
Guidelines:
```````````
* All code should have tests.
* All code should have tests (see "Test coverage" below for more details).
* All code should be documented, to the same
`standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
as NumPy and SciPy.
@@ -30,7 +30,7 @@ Guidelines:
<http://groups.google.com/group/scikits-image>`_.
Test coverage
-------------
`````````````
Tests for a module should ideally cover all code in that module, i.e. statement
coverage should be at 100%. To measure the test coverage, install `<coverage.py
http://nedbatchelder.com/code/coverage/>`_ and then run::
@@ -38,7 +38,13 @@ http://nedbatchelder.com/code/coverage/>`_ and then run::
$ make coverage
This will print a report with one line for each file in `scikits.image`,
detailing the test coverage.
detailing the test coverage::
Name Stmts Exec Cover Missing
------------------------------------------------------------------------------
scikits/image/color/colorconv 77 77 100%
scikits/image/filter/__init__ 1 1 100%
...
Bugs
````
-35
View File
@@ -96,38 +96,3 @@ checking in the API files into the repository (done) -- but the doc build
process needs to be updated to use these distributed files if they cannot be
generated from source.
Development process
-------------------
* Go to `http://github.com/stefanv/scikits.image
<http://github.com/stefanv/scikits.image>`_ and follow the instructions on
making your own fork/branch.
* Make changes to your branch, committing locally as you progress.
* Push your changes back to github.
* Ping stefan to request a merge into the main development branch.
.. note::
Do *not* merge the main branch into yours. You may rebase,
as long as you are `aware of its dangers <http://tinyurl.com/lll385>`_
(also see `LWN article <http://tinyurl.com/nqcbkj>`_).
All of this may be intimidating if you've never used git before, so we'd
happily accept plain old unified diffs (``git diff`` or ``diff -u a.txt
b.txt``) as well.
Guidelines:
```````````
* All code should have tests.
* All code should be documented, to the same
`standard <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
as NumPy and SciPy.
* Follow the `Python PEPs <http://www.python.org/dev/peps/pep-0008/>`_
where possible.
* All major changes should be `posted for review
<http://codereview.appspot.com>`_ to the `mailing list
<http://groups.google.com/group/scikits-image>`_.
Bugs
````
Please `report bugs on Github <http://github.com/stefanv/scikits.image>`_.
-1
View File
@@ -8,5 +8,4 @@ API Reference
scikits.image.color
scikits.image.filter
scikits.image.io
scikits.image.opencv
scikits.image.transform
+36
View File
@@ -7,10 +7,46 @@ Module: :mod:`color`
.. currentmodule:: scikits.image.color
.. autosummary::
scikits.image.color.convert_colorspace
scikits.image.color.hsv2rgb
scikits.image.color.rgb2hsv
scikits.image.color.rgb2rgbcie
scikits.image.color.rgb2xyz
scikits.image.color.rgbcie2rgb
scikits.image.color.xyz2rgb
convert_colorspace
------------------
.. autofunction:: scikits.image.color.convert_colorspace
hsv2rgb
-------
.. autofunction:: scikits.image.color.hsv2rgb
rgb2hsv
-------
.. autofunction:: scikits.image.color.rgb2hsv
rgb2rgbcie
----------
.. autofunction:: scikits.image.color.rgb2rgbcie
rgb2xyz
-------
.. autofunction:: scikits.image.color.rgb2xyz
rgbcie2rgb
----------
.. autofunction:: scikits.image.color.rgbcie2rgb
xyz2rgb
-------
.. autofunction:: scikits.image.color.xyz2rgb