DOC Ensures that inplace_swap_row passes numpydoc validation #24178
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
thomasjpfan
reviewed
Aug 15, 2022
sklearn/utils/sparsefuncs.py
Outdated
| @@ -361,7 +361,7 @@ def inplace_swap_row_csr(X, m, n): | |||
|
|
|||
| def inplace_swap_row(X, m, n): | |||
| """ | |||
| Swaps two rows of a CSC/CSR matrix in-place. | |||
| To swap two rows of a CSC/CSR matrix in-place. | |||
There was a problem hiding this comment.
I think we can remove the "to" here:
Suggested change
| To swap two rows of a CSC/CSR matrix in-place. | |
| Swap two rows of a CSC/CSR matrix in-place. |
There was a problem hiding this comment.
Thank you, I have changed it.
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 #21350
What does this implement/fix? Explain your changes.
Ensures that
sklearn.utils.sparsefuncs.inplace_swap_rowpasses numpydoc validation.Verified that all tests passed.
Any other comments?