PyCQA/pydocstyle

Validate missing arguments in Google docstring

Ouverte

#517 ouverte le 22 nov. 2020

 (1 commentaire) (0 réaction) (0 personne assignée)Python (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Métriques du dépôt

Stars
 (1 106 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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?

Guide contributeur