This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Validate missing arguments in Google docstring #517
Open
Description
openedon Nov 22, 2020
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?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment