PyCQA/pydocstyle

Support a new rule: no blank line after last docstring section

Aberta

#530 aberto em 1 de abr. de 2021

Ver no GitHub
 (3 comentários) (1 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

D413 says "Missing blank line after last section". It'd be awesome to have the opposite, and raise a new warning when there is a blank line at the end of a docstring. Using Google style, there shouldn't be an empty line at the end, so a warning should exist for this case.

Thank you for your consideration!

Guia do colaborador

Direção de pesquisa
Implemente uma nova regra semelhante à D413, mas inversa: verifique se há uma linha em branco após a última seção em uma docstring no estilo Google. Estude a regra D412 existente no código fonte do pydocstyle para entender o padrão, adicione a nova verificação no módulo apropriado, escreva testes e atualize a documentação.
Pilha de tecnologia
python
Domain
developer experiencetoolingtesting qa
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.
Meio dia
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
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65