PyCQA/pydocstyle

Validate missing arguments in Google docstring

Offen

#517 geöffnet am 22.11.2020

 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (191 Forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository-Metriken

Stars
 (1.106 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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?

Contributor Guide