typelevel/cats

Add doctests (excellent first-time issue)

Open

#2479 opened on Sep 7, 2018

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

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

Tech stack
None
Domain
documentationtesting
Issue type
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala basicssbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the example PR at https://github.com/typelevel/cats/pull/898/files for doctest format. Pick an uncovered type class or data type, write doctests following the pattern, and run `sbt coreJVM/test` to verify. Comment on the issue to claim your work.