DOC Birch numpydoc docstring validation #15511
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eickenberg
reviewed
Nov 2, 2019
sklearn/cluster/_k_means.py
Outdated
| @@ -648,7 +647,7 @@ def _init_centroids(X, k, init, random_state=None, x_squared_norms=None, | |||
|
|
|||
|
|
|||
| class KMeans(TransformerMixin, ClusterMixin, BaseEstimator): | |||
| """K-Means clustering | |||
| """K-Means clustering. | |||
There was a problem hiding this comment.
Other PRs are starting to put a newline after the triple quote right before the beginning of the docstring.
I prefer the convention here, but I am not sure what has been agreed upon.
There was a problem hiding this comment.
That was an issue in the validation script numpy/numpydoc#241 the current version without the newline is the correct style.
|
These changes look good to me. |
rth
reviewed
Nov 4, 2019
sklearn/ensemble/_weight_boosting.py
Outdated
| @@ -809,7 +824,7 @@ def staged_predict_proba(self, X): | |||
| The training input samples. Sparse matrix can be CSC, CSR, COO, | |||
| DOK, or LIL. COO, DOK, and LIL are converted to CSR. | |||
|
|
|||
| Returns | |||
| Yields | |||
| ------- | |||
sklearn/ensemble/_weight_boosting.py
Outdated
| @@ -1126,7 +1141,7 @@ def staged_predict(self, X): | |||
| X : {array-like, sparse matrix} of shape (n_samples, n_features) | |||
| The training input samples. | |||
|
|
|||
| Returns | |||
| Yields | |||
| ------- | |||
Co-Authored-By: Roman Yurchak <[email protected]>
Co-Authored-By: Roman Yurchak <[email protected]>
Co-Authored-By: Roman Yurchak <[email protected]>
Co-Authored-By: Roman Yurchak <[email protected]>
|
Thank you @rth , I think I commit all of your suggestions, but lmk if it didn't go through properly! |
agramfort
approved these changes
Nov 17, 2019
adrinjalali
pushed a commit
to adrinjalali/scikit-learn
that referenced
this pull request
Nov 18, 2019
adrinjalali
pushed a commit
to adrinjalali/scikit-learn
that referenced
this pull request
Nov 18, 2019
adrinjalali
pushed a commit
that referenced
this pull request
Nov 19, 2019
panpiort8
pushed a commit
to panpiort8/scikit-learn
that referenced
this pull request
Mar 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Addresses #15440 (Apply numpydoc validation to docstrings) for sklearn.cluster.Birch
What does this implement/fix? Explain your changes.
Applies numpydoc validation to sklearn.cluster.Birch docstrings
Any other comments?
All numpydoc tests passed