alteryx/evalml

Audit: write up where we need to add docstring runnable examples

Aberta

#207 aberto em 12 de nov. de 2019

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (1 responsável)Python (93 forks)auto 404
documentationgood first issuespike

Métricas do repositório

Stars
 (852 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

We should add examples to the doc strings of as many functions as possible.

We can also set these up as doctests, so that when we build the docs, the output of the method call is tested against the example.

We do this in featuretools. For example: https://docs.featuretools.com/en/stable/generated/featuretools.primitives.Count.html#featuretools.primitives.Count

Guia do colaborador

Direção de pesquisa
Identifique funções sem exemplos de docstring auditando a base de código. Siga o padrão do featuretools: adicione exemplos executáveis nos docstrings e configure como doctests. Execute testes para garantir que os exemplos passem.
Pilha de tecnologia
python
Domain
documentationtesting
Tipo Issue
Documentaçã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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75