No scaladoc for `TupleNSemigroupalOps` classes (e.g. `mapN` method)?
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
It looks like there's no scaladoc for the various Tuple*SemigroupalOps classes - e.g. on https://typelevel.github.io/cats/api/cats/syntax/package$$apply$.html there is a link to ApplyOps documentation but not to Tuple2SemigroupalOps. And searching for mapN returns nothing. I assume that's because these classes are generated from Boilerplate.scala rather than existing directly in the codebase.
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 with Boilerplate.scala and compare the generated API documentation for ApplyOps with the missing Tuple2SemigroupalOps documentation. Check how the generated Tuple*SemigroupalOps classes and mapN methods are exposed in scaladoc. Done means the tuple classes and their mapN methods are discoverable in the generated API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100