PyCQA/pydocstyle

Validate missing arguments in Google docstring

Open

#517 创建于 2020年11月22日

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

描述

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?

贡献者指南

技术栈
python
领域
documentationtooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
needs maintainer response
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python programmingFamiliarity with pydocstyle's check architecture
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
First, examine existing Google style checks in pydocstyle, such as D205 and D406 in the codebase (likely in 'src/pydocstyle/checker.py' or similar). Understand how function signatures are extracted via AST and how docstring sections are parsed using the 'GoogleDocstring' class. Then, implement a new check (e.g., D417) that compares the set of parameters from the function definition with those listed in the 'Args' section. Refer to the pydocstyle developer guide for adding new checks. The issue comment (only one) may contain further discussion, but no maintainer response yet.