Skip to content

DOC: fix SA01 for pandas.set_option #58882

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 1, 2024
Merged

DOC: fix SA01 for pandas.set_option #58882

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 @@ -488,7 +488,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.read_spss SA01" \
-i "pandas.reset_option SA01" \
-i "pandas.set_eng_float_format RT03,SA01" \
-i "pandas.set_option SA01" \
-i "pandas.show_versions SA01" \
-i "pandas.test SA01" \
-i "pandas.testing.assert_extension_array_equal SA01" \
Expand Down
8 changes: 8 additions & 0 deletions pandas/_config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,14 @@ def set_option(*args) -> None:
TypeError if keyword arguments are provided
OptionError if no such option exists

See Also
--------
get_option : Retrieve 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.
option_context : Context manager to temporarily set options in a ``with``
statement.

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