PyCQA/pydocstyle

Validate missing arguments in Google docstring

Open

#517 opened on 2020年11月22日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (1,106 stars) (191 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.