Pragmatists/JUnitParams

Add explanations to examples in documentation

Open

#141 aperta il 27 ott 2017

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)HTML (151 fork)batch import
help wanted

Metriche repository

Star
 (887 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Without explanations of the many different ways to specify parameters, figuring out how to use this library is harder than it should be.

Also, most of the examples seem to demonstrate passing just a single parameter (or a set of parameters for a single invocation). It's not obvious how to pass several parameters.

Guida contributor

Direzione di ricerca
Esamina i file di esempio esistenti e identifica dove mancano le spiegazioni; quindi aggiungi commenti descrittivi o sezioni Markdown che spiegano le variazioni dei parametri e il passaggio di più parametri.
Tech stack
java
Dominio
testing
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80