Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC add test for numpydoc validation and documented param/attributes #869

Merged
merged 10 commits into from
Oct 20, 2021

Conversation

glemaitre
Copy link
Member

Make sure that we validate both the functions and classes with numpydoc

@codecov
Copy link

codecov bot commented Oct 17, 2021

Codecov Report

Merging #869 (34837ce) into master (56eefdf) will decrease coverage by 0.27%.
The diff coverage is 86.57%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #869      +/-   ##
==========================================
- Coverage   98.84%   98.56%   -0.28%     
==========================================
  Files          93       94       +1     
  Lines        6064     6209     +145     
  Branches      508      543      +35     
==========================================
+ Hits         5994     6120     +126     
- Misses         69       77       +8     
- Partials        1       12      +11     
Impacted Files Coverage Δ
imblearn/combine/_smote_enn.py 100.00% <ø> (ø)
imblearn/combine/_smote_tomek.py 100.00% <ø> (ø)
imblearn/datasets/_imbalance.py 88.23% <ø> (ø)
imblearn/datasets/_zenodo.py 96.77% <ø> (ø)
imblearn/ensemble/_bagging.py 98.07% <ø> (ø)
imblearn/ensemble/_easy_ensemble.py 100.00% <ø> (ø)
imblearn/ensemble/_weight_boosting.py 97.75% <ø> (ø)
imblearn/exceptions.py 100.00% <ø> (ø)
imblearn/metrics/_classification.py 96.34% <ø> (ø)
imblearn/metrics/pairwise.py 100.00% <ø> (ø)
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56eefdf...34837ce. Read the comment docs.

@glemaitre glemaitre changed the title MNT validate functions and classes with numpydoc DOC add test for numpydoc validation and documented param/attributes Oct 17, 2021
@glemaitre glemaitre merged commit 58f4a11 into scikit-learn-contrib:master Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant