PyCQA/pydocstyle

Validate missing arguments in Google docstring

Open

#517 opened on Nov 22, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1,106 stars) (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

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?

Contributor guide

Tech stack
python
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingFamiliarity with pydocstyle's check architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.
Validate missing arguments in Google docstring · PyCQA/pydocstyle#517 | Good First Issue