PyCQA/pydocstyle

Don't force to add docstrings to __new__

Aberta

#515 aberto em 22 de out. de 2020

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

This should be considered a magic method (controlled by D105), or at least have a different error code (which may be D107 together with __init__ or even a new one).

Guia do colaborador

Direção de pesquisa
Comece examinando como o pydocstyle atualmente lida com métodos mágicos como init e repr . Veja o código fonte para D105 (docstring ausente em método mágico) e D107 (docstring ausente em init ). A issue sugere que new deve ser tratado de forma semelhante a init . Talvez seja necessário adicionar new à lista de métodos isentos de D105 ou criar um novo código de erro. Verifique a lógica existente nas funções de verificação e proponha uma modificação. Além disso, revise quaisquer comentários relacionados na issue para entender as preferências dos mantenedores.
Pilha de tecnologia
python
Domain
toolingdeveloper experience
Tipo Issue
Bug
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