From 575e51c0c1df2c8846b952f91adb127152dabefb Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Mon, 20 May 2024 22:21:45 +0530 Subject: [PATCH] DOC: add SA01 for pandas.get_option (#58794) --- 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 af406f816e614..ec46e043c8294 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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" \ diff --git a/pandas/_config/config.py b/pandas/_config/config.py index 8921e1b686303..1b91a7c3ee636 100644 --- a/pandas/_config/config.py +++ b/pandas/_config/config.py @@ -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 `