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

Jump to bottom

DOC: add SA01 for pandas.get_option #58794

Merged
merged 1 commit into from
May 20, 2024
Merged

DOC: add SA01 for pandas.get_option #58794

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 @@ -440,7 +440,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.errors.UnsortedIndexError SA01" \
-i "pandas.errors.UnsupportedFunctionCall SA01" \
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
-i "pandas.get_option SA01" \
-i "pandas.infer_freq SA01" \
-i "pandas.interval_range RT03" \
-i "pandas.io.formats.style.Styler.apply RT03" \
Expand Down
6 changes: 6 additions & 0 deletions pandas/_config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,12 @@ def get_option(pat: str) -> Any:
------
OptionError : if no such option exists

See Also
--------
set_option : Set the value of the specified option or options.
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