From fce1828220abd1eadf42811c26eaceea3dd1a15b Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Tue, 4 Jun 2024 11:37:58 +0530 Subject: [PATCH] DOC: fix SA01 for pandas.describe_option --- ci/code_checks.sh | 1 - pandas/_config/config.py | 6 ++++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 1e615b6df8446..57d8e5a0df46f 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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" \ diff --git a/pandas/_config/config.py b/pandas/_config/config.py index 55d9e29686259..95c549a8ff0e8 100644 --- a/pandas/_config/config.py +++ b/pandas/_config/config.py @@ -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