typelevel/cats

Add doctests (excellent first-time issue)

开放

#2,479 创建于 2018年9月7日

 (14 条评论) (0 个反应) (0 位负责人)Scala (1,241 个派生)batch import
documentationgood first issuehelp wanted

仓库指标

星标
 (5,438 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南