Skip to content

DOC Ensures that AdditiveChi2Sampler passes numpydoc validation #20536

Merged
glemaitre merged 6 commits intoscikit-learn:mainfrom
reshamas:AdditiveChi2Sampler
Jul 20, 2021
Merged

DOC Ensures that AdditiveChi2Sampler passes numpydoc validation #20536
glemaitre merged 6 commits intoscikit-learn:mainfrom
reshamas:AdditiveChi2Sampler

Conversation

@reshamas
Copy link
Copy Markdown
Member

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

Fixes numpydoc errors on AdditiveChi2Sampler functions

Any other comments?

#DataUmbrella LATAM sprint

@reshamas
Copy link
Copy Markdown
Member Author

@glemaitre
I am seeing this error, but I don't see where there is a missing period.

E           Returns
E           -------
E           self : object
E               Returns the transformer.
E           
E           # Errors
E           
E            - SS03: Summary does not end with a period

maint_tools/test_docstrings.py:293: ValueError
================================== 1 failed, 5 passed, 1750 deselected in 1.45s ==================================

@glemaitre
Copy link
Copy Markdown
Member

l. 543 maybe in the fit method.

Be aware that you need to uncomment the other estimator as well to run the checks.

@glemaitre glemaitre merged commit 137bfb3 into scikit-learn:main Jul 20, 2021
@glemaitre
Copy link
Copy Markdown
Member

Thanks @reshamas

samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…it-learn#20536)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants