[MRG] Add development doc #325
Conversation
|
all public functions in validation.py and deprecation.py There is currently nothing in testing.py to be documented. |
Codecov Report
@@ Coverage Diff @@
## master #325 +/- ##
=====================================
Coverage 98% 98%
=====================================
Files 66 66
Lines 3860 3860
=====================================
Hits 3783 3783
Misses 77 77Continue to review full report at Codecov.
|
massich
force-pushed
the
development_doc
branch
2 times, most recently
from
c615d02 to
ff2c024
Compare
massich
force-pushed
the
development_doc
branch
from
ff2c024 to
e2650a1
Compare
doc/developers_utils.rst
Outdated
|
|
||
| .. currentmodule:: imblearn.utils | ||
|
|
||
|
|
doc/developers_utils.rst
Outdated
| scikit-learn. Backports, in particular, will be removed as the scikit-learn | ||
| dependencies evolve. | ||
|
|
||
|
|
doc/developers_utils.rst
Outdated
| Utilities for Developers | ||
| ======================== | ||
|
|
||
| Imbalanced-learn contains a number of utilities to help with development. These are |
There was a problem hiding this comment.
there is a space to much between . and These
doc/developers_utils.rst
Outdated
| .. warning :: | ||
|
|
||
| These utilities are meant to be used internally within the imbalanced-learn | ||
| package. They are not guaranteed to be stable between versions of |
There was a problem hiding this comment.
space to much after full stop
doc/developers_utils.rst
Outdated
|
|
||
| These utilities are meant to be used internally within the imbalanced-learn | ||
| package. They are not guaranteed to be stable between versions of | ||
| scikit-learn. Backports, in particular, will be removed as the scikit-learn |
There was a problem hiding this comment.
scikit-learn -> imbalanced-learn
There was a problem hiding this comment.
At the end of the sentence as well
doc/developers_utils.rst
Outdated
| Validation Tools | ||
| ================ | ||
|
|
||
| These are tools used to check and validate input. When you write a function |
There was a problem hiding this comment.
Space to much after full stop
doc/developers_utils.rst
Outdated
|
|
||
| Helper Functions | ||
| ================ | ||
| These are tools to facilitate writing code for imbalance learn. |
There was a problem hiding this comment.
imbalance learn -> imbalanced-learn
massich
force-pushed
the
development_doc
branch
from
e2650a1 to
860dfbd
Compare
massich
force-pushed
the
development_doc
branch
from
1cde627 to
a3db4a4
Compare
@glemaitre which functions should be documented here?