DOC Ensures that haversine_distances passes numpydoc validation #23044
+3
−2
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
jeremiedbb
reviewed
Apr 4, 2022
There was a problem hiding this comment.
Thanks for the PR @gustavo-ren. I made a few suggestions to follow keep local consistency.
Co-authored-by: Jérémie du Boisberranger <[email protected]>
Co-authored-by: Jérémie du Boisberranger <[email protected]>
jjerphan
pushed a commit
to jjerphan/scikit-learn
that referenced
this pull request
Apr 29, 2022
…t-learn#23044) Co-authored-by: Jérémie du Boisberranger <[email protected]>
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.
Addresses #21350
Reference Issues/PRs
Modifications on metrics.pairwise.haversine_distance for docstring acceptance by the numpydoc criteria.
What does this implement/fix? Explain your changes.
Remove sklearn.metrics.pairwise.haversine_distances from test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST
Necessary modifications for the resolution of errors:
- PR07: Parameter "X" has no description
- RT03: Return value has no description
Any other comments?
No