Skip to content

DOC: fix SA01 for pandas.describe_option #58914

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

DOC: fix SA01 for pandas.describe_option #58914

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 @@ -404,7 +404,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.window.rolling.Window.std PR01" \
-i "pandas.core.window.rolling.Window.var PR01" \
-i "pandas.date_range RT03" \
-i "pandas.describe_option SA01" \
-i "pandas.errors.AbstractMethodError PR01,SA01" \
-i "pandas.errors.AttributeConflictWarning SA01" \
-i "pandas.errors.CSSWarning SA01" \
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 @@ -279,6 +279,12 @@ def describe_option(pat: str = "", _print_desc: bool = True) -> str | None:
str
If the description(s) as a string if ``_print_desc=False``.

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

Notes
-----
For all available options, please view the
Expand Down
Loading