Skip to content
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

docs: Fix the ambuiguity regarding global configuration #1349

Merged
merged 1 commit into from
Feb 19, 2025
Merged

docs: Fix the ambuiguity regarding global configuration #1349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions skore/src/skore/_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ def get_config():

See Also
--------
config_context : Context manager for local skore configuration.
set_config : Set global skore configuration.
config_context : Context manager for skore configuration.
set_config : Set skore configuration.

Examples
--------
Expand All @@ -48,7 +48,11 @@ def get_config():
def set_config(
show_progress: bool = None,
):
"""Set global skore configuration.
"""Set skore configuration.

Setting the configuration affects global settings meaning that it will be used
by all skore functions and classes, even in the processes and threads spawned by
skore.

Parameters
----------
Expand All @@ -57,8 +61,8 @@ def set_config(

See Also
--------
config_context : Context manager for local skore configuration.
get_config : Retrieve current values of the global configuration.
config_context : Context manager for skore configuration.
get_config : Retrieve current values of the configuration.

Examples
--------
Expand All @@ -76,7 +80,11 @@ def config_context(
*,
show_progress: bool = None,
):
"""Context manager for local skore configuration.
"""Context manager for skore configuration.

Setting the configuration affects global settings meaning that it will be used
by all skore functions and classes, even in the processes and threads spawned by
skore.

Parameters
----------
Expand All @@ -89,8 +97,8 @@ def config_context(

See Also
--------
set_config : Set global skore configuration.
get_config : Retrieve current values of the global configuration.
set_config : Set skore configuration.
get_config : Retrieve current values of the configuration.

Notes
-----
Expand Down