PyCQA/pydocstyle

Validate missing arguments in Google docstring

オープン

#517 opened on 2020/11/22

 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Python (191 件のフォーク)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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?

コントリビューターガイド