typelevel/cats

Add doctests (excellent first-time issue)

Open

#2,479 opened on Sep 7, 2018

View on GitHub
 (14 comments) (0 reactions) (0 assignees)Scala (1,241 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (5,438 stars)
PR merge metrics
 (Avg merge 4h 2m) (5 merged PRs in 30d)

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.

Contributor guide

Research direction
Choose a type class or data type from the Cats library, write doctests for its methods following the example PR, and run `sbt coreJVM/test` to verify.
Tech stack
None
Domain
documentationtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85