DOC Ensures that function passes numpydoc validation: paired_distances#22380
Merged
glemaitre merged 4 commits intoscikit-learn:mainfrom Feb 11, 2022
Merged
DOC Ensures that function passes numpydoc validation: paired_distances#22380glemaitre merged 4 commits intoscikit-learn:mainfrom
glemaitre merged 4 commits intoscikit-learn:mainfrom
Conversation
Member
Author
|
@glemaitre I was not sure how to resolve this numpy doc error: E
E # Errors
E
E - PR01: Parameters {'**kwds'} not documented
sklearn/tests/test_docstrings.py:364: ValueError
============================================= 1 failed, 2107 deselected in 1.03s =============================================
(sklearndev) |
glemaitre
reviewed
Feb 7, 2022
| @@ -1000,9 +1000,9 @@ def paired_cosine_distances(X, Y): | |||
|
|
|||
| def paired_distances(X, Y, *, metric="euclidean", **kwds): | |||
Member
There was a problem hiding this comment.
You are missing a docstring for the **kwds argument
Member
Author
There was a problem hiding this comment.
Thanks @glemaitre. Added the docstring for that now.
Member
There was a problem hiding this comment.
So we decided to not deprecate and remove this parameter.
We can document it and mentioned that it is not used at the moment.
Member
Author
|
Reminder from discussion with @glemaitre: |
reshamas
commented
Feb 10, 2022
Comment on lines
+1027
to
+1029
| **kwds : dict | ||
| Unused parameters. | ||
|
|
Member
|
Thanks @reshamas, the changes are good. |
thomasjpfan
pushed a commit
to thomasjpfan/scikit-learn
that referenced
this pull request
Mar 1, 2022
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 #21350.
Closes #21440.
What does this implement/fix? Explain your changes.
Updates docstring in function to fix numpydoc errors.
Any other comments?
#DataUmbrella sprint