Unclear error statement printed when `python ./scripts/validate_docstrings.py --errors=PR02` is run

When I run python ./scripts/validate_docstrings.py --errors=PR02, one of the error statements printed is /home/pandas/pandas/core/generic.py:1092:PR02:pandas.DataFrame.rename_axis:Unknown parameters {'inplace'}. However in the generic.py file, “inplace” is declared in the function, overloaded functions, and the doc-string, so I was unsure what the error statement meant.

[MarcoGorelli]

Thanks - where is it needed? Aren’t the overloads enough? e.g.

(pandas-dev) marco@marco-Predator-PH315-52:~/pandas-marco$ cat t.py 
import pandas as pd

df = pd.DataFrame({'a': [1,2,3]})

reveal_type(df.rename_axis(index='foo'))
reveal_type(df.rename_axis(index='foo', inplace=True))
(pandas-dev) marco@marco-Predator-PH315-52:~/pandas-marco$ mypy t.py 
t.py:5: note: Revealed type is "pandas.core.frame.DataFrame"
t.py:6: note: Revealed type is "None"
Success: no issues found in 1 source file

[twoertwein]

Aren’t the overloads enough?

That’s a good point! The overloads might actually be enough. When a function has overloads, the implementation is not actually used for type checking (there might be some consistency checks between overloads and implementation but you could add an ignore comment if needed).