Skip to content

DOC Ensures that config_context passes numpydoc validation#21426

Merged
jjerphan merged 9 commits intoscikit-learn:mainfrom
miwojc:issue21350-config_context
Oct 29, 2021
Merged

DOC Ensures that config_context passes numpydoc validation#21426
jjerphan merged 9 commits intoscikit-learn:mainfrom
miwojc:issue21350-config_context

Conversation

@miwojc
Copy link
Copy Markdown
Contributor

@miwojc miwojc commented Oct 23, 2021

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Any other comments?

This is my and @majauhar first pull request made during #DataUmbrella sprint.

Co-authored-by: majauhar <siddmohamed19@gmail.com>
@jjerphan jjerphan self-requested a review October 23, 2021 16:28
@reshamas
Copy link
Copy Markdown
Member

#DataUmbrella sprint
cc: @nestornav

Copy link
Copy Markdown
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

I think in this case, it's better to change the signature of the function instead of changing the docstring. Please remove **new_config, and include all the arguments in the signature of the function.

@glemaitre
Copy link
Copy Markdown
Member

I agree with @adrinjalali. We try to limit as much as possible **kwargs and have explicit keyword arguments.

…f the function

Co-authored-by: majauhar <siddmohamed19@gmail.com>
…ction signature

Co-authored-by: majauhar <siddmohamed19@gmail.com>
…rd arguments

Co-authored-by: majauhar <siddmohamed19@gmail.com>
Copy link
Copy Markdown
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. Maybe just a second review on this one.
ping @adrinjalali @jjerphan

Copy link
Copy Markdown
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 after changing default values to None as mentioned in this thread: https://github.com/scikit-learn/scikit-learn/pull/21426/files#r735161499

…et_config.

Co-authored-by: majauhar <siddmohamed19@gmail.com>
Co-authored-by: majauhar <siddmohamed19@gmail.com>
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

@jjerphan jjerphan merged commit 01551ad into scikit-learn:main Oct 29, 2021
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…arn#21426)

Co-authored-by: majauhar <siddmohamed19@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Dec 24, 2021
…arn#21426)

Co-authored-by: majauhar <siddmohamed19@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
glemaitre added a commit that referenced this pull request Dec 25, 2021
Co-authored-by: majauhar <siddmohamed19@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
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.

7 participants