typelevel/cats

Add doctests (excellent first-time issue)

Open

#2479 aperta il 7 set 2018

Vedi su GitHub
 (14 commenti) (0 reazioni) (0 assegnatari)Scala (1241 fork)batch import
documentationgood first issuehelp wanted

Metriche repository

Star
 (5438 star)
Metriche merge PR
 (Merge medio 4h 2m) (5 PR mergiate in 30 g)

Descrizione

Doctests are a great way to provide compilable and testable example code for scaladoc. We should cover as many methods with doctests as possible. Here is an example of PR adding doctests. Note that to test the doctests run sbt coreJVM/test This issue encompasses the effort of adding more doctest coverage to our type classes and data types. It would be a great first-time contribution.

If you are interested, please comment here on what type classes or data types you'd like to work on.

Guida contributor

Direzione di ricerca
Scegli un type class o un tipo di dato dalla libreria Cats, scrivi doctest per i suoi metodi seguendo la PR di esempio, ed esegui `sbt coreJVM/test` per verificare.
Tech stack
Nessuno
Dominio
documentationtesting
Tipo issue
Test
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
Scalasbt
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85