Skip to content

DOC Improve docstrings for scikit-learn configuration functions #31486

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

StefanieSenger
Copy link
Contributor

@StefanieSenger StefanieSenger commented Jun 5, 2025

This PR improves the docstrings of set_config, get_config, config_context, to help users understand how to use them.

Specifically:

  • explains the concept of global default configurations
  • better distinguishes between function argument defaults (None) and global defaults

Copy link

github-actions bot commented Jun 5, 2025

✔️ Linting Passed

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

Generated for commit: 6d823bf. Link to the linter CI: here

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.

1 participant