DOC: add SA01 for pandas.get_option (#58794)

pandas-dev · May 20, 2024 · 575e51c · 575e51c
1 parent 3f8f704
commit 575e51c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git 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
@@ -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>`