Skip to content

DOC Ensures that inplace_swap_row passes numpydoc validation#24178

Merged
thomasjpfan merged 2 commits intoscikit-learn:mainfrom
ak04p:doc-valid2
Aug 16, 2022
Merged

DOC Ensures that inplace_swap_row passes numpydoc validation#24178
thomasjpfan merged 2 commits intoscikit-learn:mainfrom
ak04p:doc-valid2

Conversation

@ak04p
Copy link
Copy Markdown
Contributor

@ak04p ak04p commented Aug 13, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Ensures that sklearn.utils.sparsefuncs.inplace_swap_row passes numpydoc validation.
Verified that all tests passed.

Any other comments?

Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR!

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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I have changed it.

Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants