Skip to content

DOC Fix default value of n in check_cv #29024

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 2 commits into from
May 16, 2024
Merged

DOC Fix default value of n in check_cv #29024

merged 2 commits into from
May 16, 2024

Conversation

Tialo
Copy link
Contributor

@Tialo Tialo commented May 15, 2024

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

@github-actions GitHub Actions
Copy link

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 2ced59b. Link to the linter CI: here

@Tialo
Copy link
Contributor Author

Tialo commented May 15, 2024

As I see, the documentation was copy-pasted from cross_validate, cross_val_score, etc. In these methods default value of cv specified as None, maybe it is reasonable to change default value to None and don't change docstring for the sake of consistency

@glemaitre
Copy link
Member

glemaitre commented May 16, 2024 •
edited
Loading

No we should not change the default. Otherwise, we would need to have a deprecation cycle. Since this is only a developer tool, this is not worth making the change.

glemaitre
glemaitre approved these changes May 16, 2024
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.

Merging thanks @Tialo

@glemaitre glemaitre merged commit 945273d into scikit-learn:main May 16, 2024
30 checks passed
@Tialo Tialo deleted the patch-1 branch May 16, 2024 08:13
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request May 20, 2024
@Tialo @jeremiedbb
DOC Fix default value of n in check_cv (scikit-learn#29024)
9bd8a19
@jeremiedbb jeremiedbb mentioned this pull request May 20, 2024
Merged
14 tasks
jeremiedbb pushed a commit that referenced this pull request May 21, 2024
@Tialo @jeremiedbb
DOC Fix default value of n in check_cv (#29024)
43b02ec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@Tialo @glemaitre