8000 DOC Ensures that Pipeline passes numpydoc validation by jmloyola · Pull Request #20969 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Ensures that Pipeline passes numpydoc validation #20969

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 9, 2021
Merged

DOC Ensures that Pipeline passes numpydoc validation #20969

merged 6 commits into from
Sep 9, 2021

Conversation

jmloyola
Copy link
Member
@jmloyola jmloyola commented Sep 8, 2021

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures Pipeline is compatible with numpydoc.

  • Remove Pipeline from DOCSTRING_IGNORE_LIST.
  • Verify that all tests are passing.

glemaitre
glemaitre reviewed Sep 8, 2021
View reviewed changes
Copy link
Member
@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM

@jmloyola @glemaitre
Update sklearn/pipeline.py
199a0f0 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
glemaitre reviewed Sep 8, 2021
View reviewed changes
ogrisel
ogrisel approved these changes Sep 8, 2021
View reviewed changes
Copy link
Member
@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM.

@jmloyola @glemaitre
Apply suggestions from code review
8a41c6f 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
glemaitre reviewed Sep 9, 2021
View reviewed changes
glemaitre
glemaitre approved these changes Sep 9, 2021
View reviewed changes
Copy link
Member
@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. Just waiting for the CI to pass

@glemaitre glemaitre self-requested a review September 9, 2021 08:30
glemaitre
glemaitre approved these changes Sep 9, 2021
View reviewed changes
Copy link
Member
@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

When debugging the failure, I pushed some other changes that also improve the docstring.
Let see if the CI passes

@glemaitre glemaitre merged commit 82f0ab9 into scikit-learn:main Sep 9, 2021
@jmloyola jmloyola deleted the fix_numpydoc_pipeline branch September 9, 2021 11:34
adrinjalali pushed a commit to adrinjalali/scikit-learn that referenced this pull request Sep 20, 2021
@jmloyola @glemaitre @adrinjalali
DOC Ensures that Pipeline passes numpydoc validation (scikit-learn#20969
3d8583a 
)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
adrinjalali pushed a commit that referenced this pull request Sep 23, 2021
@jmloyola @glemaitre @adrinjalali
DOC Ensures that Pipeline passes numpydoc validation (#20969)
b811286 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@jmloyola @glemaitre @samronsin
DOC Ensures that Pipeline passes numpydoc validation (scikit-learn#20969
1a612f9 
)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ogrisel ogrisel ogrisel approved these changes

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
Documentation module:pipeline
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jmloyola @ogrisel @glemaitre
0