rapidsai/cudf

Enable numpydoc validation

Open

#11.253 aberto em 12 de jul. de 2022

Ver no GitHub
 (25 comments) (0 reactions) (0 assignees)C++ (735 forks)batch import
0 - BacklogPythondocgood first issue

Métricas do repositório

Stars
 (6.000 stars)
Métricas de merge de PR
 (Mesclagem média 17d 21h) (230 fundiu PRs em 30d)

Description

numpydoc supports docstring validation that we should enable to supplement things like pydocstyle checks. The numpydoc validation will help us with more semantic checking, such as ensuring that docstrings actually align with the function signatures that they are attached to.

Guia do colaborador

Direção de pesquisa
Revise os comentários da issue para qualquer discussão anterior sobre detalhes de implementação e possíveis armadilhas. Examine a configuração de validação de documentação existente do projeto nos arquivos de configuração de CI (por exemplo, .github/workflows, setup.cfg) para entender como integrar a validação numpydoc. A documentação do numpydoc fornece orientações sobre como habilitar a validação. As funções específicas a serem validadas são funções Python no cuDF.
Pilha de tecnologia
python
Domain
documentationdeveloper experience
Tipo Issue
Manutenção
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75