Skip to content

Commit f55bec1

Browse files
DOC: fix SA01 for pandas.describe_option (#58914)
1 parent dcb542b commit f55bec1

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
403403
-i "pandas.core.window.rolling.Window.std PR01" \
404404
-i "pandas.core.window.rolling.Window.var PR01" \
405405
-i "pandas.date_range RT03" \
406-
-i "pandas.describe_option SA01" \
407406
-i "pandas.errors.AbstractMethodError PR01,SA01" \
408407
-i "pandas.errors.AttributeConflictWarning SA01" \
409408
-i "pandas.errors.CSSWarning SA01" \

pandas/_config/config.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,12 @@ def describe_option(pat: str = "", _print_desc: bool = True) -> str | None:
279279
str
280280
If the description(s) as a string if ``_print_desc=False``.
281281
282+
See Also
283+
--------
284+
get_option : Retrieve the value of the specified option.
285+
set_option : Set the value of the specified option or options.
286+
reset_option : Reset one or more options to their default value.
287+
282288
Notes
283289
-----
284290
For all available options, please view the

0 commit comments

Comments
 (0)