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 (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Implement a new DARxxx check in pydocstyle to verify that all function parameters are documented in Google style docstrings when at least one parameter is documented.
Tech stack
python
Domain
toolingdeveloper experience
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65