10000 [MRG] DOC Fix documentation of default values in cluster module · Pull Request #17455 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

[MRG] DOC Fix documentation of default values in cluster module #17455

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 4 commits into from Jun 7, 2020
Merged

[MRG] DOC Fix documentation of default values in cluster module #17455

merged 4 commits into from Jun 7, 2020

Conversation

ghost
Copy link
@ghost ghost commented Jun 5, 2020

Reference Issues/PRs

Delivers towards #15761

What does this implement/fix? Explain your changes.

Makes changes to docstrings to remove optional and specify default=None. Also some generic docstring updates inline with guidance.

Any other comments?

This only delivers updates to the cluster module

Copy link
Member
@alfaro96 alfaro96 left a comment

Choose a reason for hiding this comment

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

Thanks @pgithubs!

I provide some minor comments.

@ghost
Copy link
Author
ghost commented Jun 5, 2020

Thanks for the review @alfaro96 , I've made those changes now.

Copy link
Member
@alfaro96 alfaro96 left a comment

Choose a reason for hiding this comment

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

LGTM when these changes are applied.

Thanks @pgithubs!

Copy link
Member
@alfaro96 alfaro96 left a comment

Choose a reason for hiding this comment

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

Thanks @pgithubs!

Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

LGTM

@thomasjpfan thomasjpfan merged commit b4fa62e into scikit-learn:master Jun 7, 2020
@ghost ghost deleted the DOC-Fix-documentation-of-default-values-in-cluster branch June 7, 2020 19:42
viclafargue pushed a commit to viclafargue/scikit-learn that referenced this pull request Jun 26, 2020
…rn#17455)

* updated _affinity_propagation.py docstrings in line with scikit-learn#15761

* updated cluster module docstrings in line with scikit-learn#15761

* updated cluster module docstrings post review scikit-learn#15761

* updated cluster module docstrings post review scikit-learn#15761

Co-authored-by: Greg Knowles <gitgreg123@users.noreply.github.com>
jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020
…rn#17455)

* updated _affinity_propagation.py docstrings in line with scikit-learn#15761

* updated cluster module docstrings in line with scikit-learn#15761

* updated cluster module docstrings post review scikit-learn#15761

* updated cluster module docstrings post review scikit-learn#15761

Co-authored-by: Greg Knowles <gitgreg123@users.noreply.github.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.

3 participants
0