diff --git a/DEVELOPMENT.txt b/DEVELOPMENT.txt index 61b6f7eb..7ce18d25 100644 --- a/DEVELOPMENT.txt +++ b/DEVELOPMENT.txt @@ -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 `_ as NumPy and SciPy. @@ -30,7 +30,7 @@ Guidelines: `_. 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 ``_ 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 ```` diff --git a/TASKS.txt b/TASKS.txt index 1ec192c7..cd9c8e5e 100644 --- a/TASKS.txt +++ b/TASKS.txt @@ -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 - `_ 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 `_ - (also see `LWN article `_). - -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 `_ - as NumPy and SciPy. - * Follow the `Python PEPs `_ - where possible. - * All major changes should be `posted for review - `_ to the `mailing list - `_. - -Bugs -```` -Please `report bugs on Github `_. - diff --git a/doc/source/api/api.txt b/doc/source/api/api.txt index 3b5b4ba1..921a226d 100644 --- a/doc/source/api/api.txt +++ b/doc/source/api/api.txt @@ -8,5 +8,4 @@ API Reference scikits.image.color scikits.image.filter scikits.image.io - scikits.image.opencv scikits.image.transform diff --git a/doc/source/api/scikits.image.color.txt b/doc/source/api/scikits.image.color.txt index eb7a91c4..ee2bbe8f 100644 --- a/doc/source/api/scikits.image.color.txt +++ b/doc/source/api/scikits.image.color.txt @@ -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 +