PyCQA/pydocstyle

Add flag to ignore some functions, classes or class methods

Aberta

#537 aberto em 13 de mai. de 2021

Ver no GitHub
 (1 comentário) (4 reações) (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

My problem

I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.

My solution idea

It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be --ignore-func='.*\.__init__', with .* for the class name, \. to say that it's a class method and __init__ to ignore that method.

Guia do colaborador

Direção de pesquisa
Observe a análise de argumentos de linha de comando do pydocstyle (provavelmente usando argparse ou similar) e a lógica que determina quais docstrings verificar. Implemente uma nova flag de linha de comando, por exemplo ignore func, que aceita um padrão regex. Em seguida, ao verificar funções, classes e métodos, pule aqueles cujo nome qualificado corresponda ao padrão. Garanta que a regex seja aplicada ao nome completo com pontos (ex: ClassName. init ). Forneça testes para o novo recurso.
Pilha de tecnologia
python
Domain
tooling
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70