PyCQA/pydocstyle

Validate missing arguments in Google docstring

Open

#517 创建于 2020年11月22日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

仓库指标

Star
 (1,106 star)
PR 合并指标
 (30 天内没有已合并 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?

贡献者指南