pydocstyle icon indicating copy to clipboard operation
pydocstyle copied to clipboard

[Feature Request] Error for documented parameters that do not exist

Open nioncode opened this issue 5 years ago • 0 comments

The following example code has a parameter named oops in the docstring, although it does not exist (anymore) in the function signature:

def foo(arg) -> None:
    """Description.

    Args:
        arg: description
        oops: parameter that was used before refactoring
    """
    pass

Currently, there is no error raised for parameter oops. E.g. pycharm prints a warning in that case that says: Function 'foo' does not have a parameter 'oops'.

It would be great if pydocstyle would generate an error for this case as well.

nioncode avatar Mar 07 '20 09:03 nioncode