Skip to content

DOC: fix SA01 for pandas.option_context #58897

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

Merged
merged 1 commit into from
Jun 3, 2024
Merged

DOC: fix SA01 for pandas.option_context #58897

Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.merge PR07" \
-i "pandas.merge_asof PR07,RT03" \
-i "pandas.merge_ordered PR07" \
-i "pandas.option_context SA01" \
-i "pandas.period_range RT03,SA01" \
-i "pandas.pivot PR07" \
-i "pandas.pivot_table PR07" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/_config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,13 @@ def option_context(*args) -> Generator[None, None, None]:
None
No return value.

See Also
--------
get_option : Retrieve the value of the specified option.
set_option : Set the value of the specified option.
reset_option : Reset one or more options to their default value.
describe_option : Print the description for one or more registered options.

Notes
-----
For all available options, please view the :ref:`User Guide <options.available>`
Expand Down
Loading