Skip to content

Commit 4a9ac5a

Browse files
DOC: fix SA01 for pandas.set_option (#58882)
1 parent 55f32cd commit 4a9ac5a

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
488488
-i "pandas.read_spss SA01" \
489489
-i "pandas.reset_option SA01" \
490490
-i "pandas.set_eng_float_format RT03,SA01" \
491-
-i "pandas.set_option SA01" \
492491
-i "pandas.show_versions SA01" \
493492
-i "pandas.testing.assert_extension_array_equal SA01" \
494493
-i "pandas.testing.assert_series_equal PR07,SA01" \

pandas/_config/config.py

+8
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,14 @@ def set_option(*args) -> None:
211211
TypeError if keyword arguments are provided
212212
OptionError if no such option exists
213213
214+
See Also
215+
--------
216+
get_option : Retrieve the value of the specified option.
217+
reset_option : Reset one or more options to their default value.
218+
describe_option : Print the description for one or more registered options.
219+
option_context : Context manager to temporarily set options in a ``with``
220+
statement.
221+
214222
Notes
215223
-----
216224
For all available options, please view the :ref:`User Guide <options.available>`

0 commit comments

Comments
 (0)