Skip to content

DOC Ensures that inplace_swap_column passes numpydoc validation#23476

Merged
thomasjpfan merged 2 commits intoscikit-learn:mainfrom
harshit5674:my_feature
May 27, 2022
Merged

DOC Ensures that inplace_swap_column passes numpydoc validation#23476
thomasjpfan merged 2 commits intoscikit-learn:mainfrom
harshit5674:my_feature

Conversation

@harshit5674
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fixed docstring to allow sklearn.utils.sparsefuncs.inplace_swap_column docstring to pass numpydoc validation.
Changed in accordance to SS05: Summary must start with infinitive verb, not third person.

Any other comments?

@harshit5674
Copy link
Copy Markdown
Contributor Author

This is my first real contribution, if I have messed up anything please let me know, I would fix 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.

Thank you for the PR @harshit5674 !

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
@harshit5674
Copy link
Copy Markdown
Contributor Author

Thank you for the response !
I committed the suggested changes.

@thomasjpfan thomasjpfan changed the title DOC Ensures that sklearn.utils.sparsefuncs.inplace_swap_column passes numpydoc validation DOC Ensures that inplace_swap_column passes numpydoc validation May 27, 2022
@thomasjpfan thomasjpfan merged commit a2c4d8b into scikit-learn:main May 27, 2022
@harshit5674 harshit5674 deleted the my_feature branch May 31, 2022 07:42
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
…it-learn#23476)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Co-authored-by: harshit5674 <harshit@Harshits-MacBook-Air.local>
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Co-authored-by: harshit5674 <harshit@Harshits-MacBook-Air.local>
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