ThinkR-open/inca3

Pimp the documentation

Ouverte

#7 ouverte le 30 nov. 2020

Voir sur GitHub
 (3 commentaires) (0 réaction) (0 personne assignée)R (0 fork)auto 404
documentationgood first issuehacktoberfest-accepted

Métriques du dépôt

Stars
 (5 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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?

Guide contributeur

Direction de recherche
Examinez les vignettes et extrayez le texte descriptif pour chaque ensemble de données, puis intégrez ces informations dans les fichiers de documentation de l'ensemble de données (par exemple en utilisant roxygen2) pour fournir des pages d'aide plus claires et une page d'accueil plus informative.
Stack technique
r
Domaine
documentationdata
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rroxygen2
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70