Skip to content

DOC Ensures that SplineTransformer passes numpydoc validation #21248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

Pinky-Chaudhary
Copy link
Contributor

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures SplineTransformer is compatible with numpydoc:

  • Remove SplineTransformer from DOCSTRING_IGNORE_LIST.
  • Verify that all tests are passing.
  • Change docstrings to maintain consistency.

Copy link
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you, @Pinky-Chaudhary.

@Pinky-Chaudhary
Copy link
Contributor Author

Thanks @jjerphan for review, would like to ask you to label this PR as hacktoberfest-accepted if you don't mind

@Pinky-Chaudhary
Copy link
Contributor Author

Sorry for Initiating a re-review it was by mistake please ignore that.

@adrinjalali adrinjalali merged commit cd87551 into scikit-learn:main Oct 7, 2021
@Pinky-Chaudhary Pinky-Chaudhary deleted the fix_numpydoc_splinetransformer branch October 7, 2021 10:33
jjerphan pushed a commit to jjerphan/scikit-learn that referenced this pull request Oct 8, 2021
…-learn#21248)

* Remove SplineTransformer from DOCSTRING_IGNORE_LIST

* Fix numpydocs from SplineTransformer
@glemaitre glemaitre mentioned this pull request Oct 23, 2021
10 tasks
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 23, 2021
…-learn#21248)

* Remove SplineTransformer from DOCSTRING_IGNORE_LIST

* Fix numpydocs from SplineTransformer
glemaitre pushed a commit that referenced this pull request Oct 25, 2021
* Remove SplineTransformer from DOCSTRING_IGNORE_LIST

* Fix numpydocs from SplineTransformer
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…-learn#21248)

* Remove SplineTransformer from DOCSTRING_IGNORE_LIST

* Fix numpydocs from SplineTransformer
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.

3 participants