typelevel/cats

Add doctests (excellent first-time issue)

Open

#2 479 ouverte le 7 sept. 2018

Voir sur GitHub
 (14 commentaires) (0 réactions) (0 assignés)Scala (1 241 forks)batch import
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (5 438 stars)
Métriques de merge PR
 (Merge moyen 4h 2m) (5 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Choisissez une classe de type ou un type de donnée de la bibliothèque Cats, écrivez des doctests pour ses méthodes en suivant l'exemple de PR, et exécutez `sbt coreJVM/test` pour vérifier.
Stack technique
Aucun
Domaine
documentationtesting
Type d'issue
Test
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
Scalasbt
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85