Closed
Description
Pandas version checks
- I have checked that the issue still exists on the latest versions of the docs on
main
here
Location of the documentation
pandas.set_option
Documentation problem
Encountered when fixing up PR02 errors in #57111
The documented arguments for pandas.set_option
are (pat, value)
per the docstring:
pandas/pandas/_config/config.py
Line 328 in f636d7d
The actual function arguments of the underlying _set_option
function are (*args, **kwargs)
because it accepts pairs of patterns to update values to.
pandas/pandas/_config/config.py
Line 157 in f636d7d
Suggested fix for documentation
Either:
- The docstring and documentation should be updated to note that it accepts args and kwargs; or
- The implementation should be updated to match the documentation, at the risk of breaking anything that relies on undocumented behaviour