ThinkR-open/inca3

Pimp the documentation

Aberta

#7 aberto em 30 de nov. de 2020

Ver no GitHub
 (3 comentários) (0 reação) (0 responsável)R (0 fork)auto 404
documentationgood first issuehacktoberfest-accepted

Métricas do repositório

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

Description

It's currently hard to navigate through the various dataset:

  • Help pages are not informative: column with types doesn't help understanding what they mean, and description + usage doesn't inform about the content of the dataset

Screenshot 2020-11-30 at 09 54 47

  • Home page just displays the name of the dataset

Screenshot 2020-11-30 at 09 55 58

Given that a lot of these are described in the Vignette, I suggest we reuse these information inside the dataset documentation?

Guia do colaborador

Direção de pesquisa
Examine as vinhetas e extraia o texto descritivo para cada conjunto de dados, depois integre essas informações nos arquivos de documentação do conjunto de dados (por exemplo, usando roxygen2) para fornecer páginas de ajuda mais claras e uma página inicial mais informativa.
Pilha de tecnologia
r
Domain
documentationdata
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
Rroxygen2
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70