DOC Ensures that sklearn.utils.validation.indexable passes numpydoc validation #21431
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
Co-authored-by: miwojc <miwojc@protonmail.com>
glemaitre
reviewed
Oct 23, 2021
There was a problem hiding this comment.
Thanks for the PR. I propose a small suggestion to follow what is proposed in numpydoc:
- since we return
result, we can use it as a name of a variable - we can specify what to expect as type in the returned list.
- adding the specificity of passing
Nonethrough in the results.
Modifies the Returns section in the docstring of indexable() function to make it more informative and clear. Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
|
Thanks @majauhar LGTM |
ogrisel
pushed a commit
to ogrisel/scikit-learn
that referenced
this pull request
Oct 28, 2021
…alidation (scikit-learn#21431) Co-authored-by: miwojc <miwojc@protonmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
…alidation (scikit-learn#21431) Co-authored-by: miwojc <miwojc@protonmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Dec 24, 2021
…alidation (scikit-learn#21431) Co-authored-by: miwojc <miwojc@protonmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
that referenced
this pull request
Dec 25, 2021
…alidation (#21431) Co-authored-by: miwojc <miwojc@protonmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free
to join this conversation on GitHub.
Alread
63D1
y 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.
Co-authored-by: miwojc miwojc@protonmail.com
Reference Issues/PRs
Addresses #21350
What does this implement/fix? Explain your changes.
Any other comments?
This is my and @miwojc second pull request made during #DataUmbrella sprint.