Add doctests (excellent first-time issue)
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the example doctest PR linked in the issue and identify a type class or data type to cover. Add compilable, testable Scaladoc examples for the selected methods, then run sbt coreJVM/test to verify the doctests pass; done means the chosen APIs have additional working doctest coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100