ThinkR-open/inca3

Pimp the documentation

Aperta

#7 aperta il 30 nov 2020

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)R (0 fork)auto 404
documentationgood first issuehacktoberfest-accepted

Metriche repository

Star
 (5 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina i vignette ed estrai il testo descrittivo per ogni dataset, quindi integra quelle informazioni nei file di documentazione del dataset (ad esempio usando roxygen2) per fornire pagine di aiuto più chiare e una home page più informativa.
Tech stack
r
Dominio
documentationdata
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rroxygen2
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70