pydocstyle icon indicating copy to clipboard operation
pydocstyle copied to clipboard

Validate missing arguments in Google docstring

Open woop opened this issue 4 years ago • 1 comments

Should pydocstyle be validating that all arguments are set when using Google style docstrings?

When I have the following in test.py

"""Create a Test."""


def functor(foo, bar):
    """Call the functor.

    Args:
        foo: This is the bar argument

    Returns:
        object: 
    """
    print("bar")

and I run

pydocstyle --convention=google test.py

All checks pass, but I was hoping it would flag the missing bar argument in the docstring.

I am looking for enforcement of arguments. At the very least when one argument is specified I would like the other arguments to be specified.

Is this a bug or is there no implementation for this check yet?

woop avatar Nov 22 '20 09:11 woop

Duplicate of #459

adamjstewart avatar Dec 29 '21 18:12 adamjstewart