PyCQA/pydocstyle

Validate missing arguments in Google docstring

Aperta

#517 aperta il 22 nov 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Metriche repository

Star
 (1106 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Implementa un nuovo controllo DARxxx in pydocstyle per verificare che tutti i parametri della funzione siano documentati nelle docstring in stile Google quando almeno un parametro è documentato.
Tech stack
python
Dominio
toolingdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65