Skip to content

DOC Improved docstrings validation in MiniBatchKMeans #15461

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

Merged
merged 6 commits into from
Nov 3, 2019

Conversation

Yinglr
Copy link
Contributor

@Yinglr Yinglr commented Nov 2, 2019

Improving doctstrings in MiniBatchKMeans, fixes #15440

@TomDLT
Copy link
Member

TomDLT commented Nov 2, 2019

Please mention the issue your are addressing in the pull-request message, in this case #15440 I guess.

@TomDLT
Copy link
Member

TomDLT commented Nov 2, 2019

If you finished fixing the doc of one estimator, can you add the estimator to the whitelist in maint_tools/test_docstrings.py here ?

Copy link
Member

@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Yinglr!

@rth
Copy link
Member

rth commented Nov 3, 2019

add the estimator to the whitelist in maint_tools/test_docstrings.py

I think it's fine, we can fix this in one go at the end, rather than reminding to do it in each PR. Currently the fixed checks will be marked as XPASS instead of XFAIL which is good enough to detect them.

@rth rth merged commit 5421bc7 into scikit-learn:master Nov 3, 2019
@rth rth changed the title Improved docstrings in MiniBatchKMeans DOC Improved docstrings validation in MiniBatchKMeans Nov 3, 2019
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.

Apply numpydoc validation to docstrings
3 participants