PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Aberta

#516 aberto em 22 de out. de 2020

Ver no GitHub
 (0 comentário) (3 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 way all methods/classes/etc will be verified, not only public ones.

Guia do colaborador

Direção de pesquisa
Investigue como o pydocstyle atualmente lida com opções de configuração, por exemplo, examinando o arquivo 'config.py' e flags existentes como ' add ignore' ou ' match'. Entenda a lógica de verificação em 'pydocstyle/checker.py' para ver onde a distinção público/privado é aplicada. A solicitação de recurso pede uma flag para incluir métodos privados; uma boa implementação pode adicionar uma opção CLI e um campo de configuração correspondente, então modificar o loop de verificação para também verificar membros privados quando a flag estiver definida.
Pilha de tecnologia
python
Domain
documentation
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
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75