PyCQA/pydocstyle

Validate missing arguments in Google docstring

Aberta

#517 aberto em 22 de nov. de 2020

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Python (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Métricas do repositório

Stars
 (1.106 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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?

Guia do colaborador

Direção de pesquisa
Implemente uma nova verificação DARxxx no pydocstyle para verificar se todos os parâmetros da função estão documentados nas docstrings no estilo Google quando pelo menos um parâmetro é documentado.
Pilha de tecnologia
python
Domain
toolingdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65