Emit scaladoc for package private classes
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
If I want to find out where the validNel extension method is coming from, one option is to search for it in the scaladoc. I will find https://typelevel.org/cats/api/cats/syntax/package$$validated$.html and https://typelevel.org/cats/api/cats/syntax/ValidatedIdSyntax.html. Mystery solved.
If however I'm looking for validNec I will find nothing because it's in another trait ValidatedIdOpsBinCompat0 which is package private.
Regardless of the reasons and decisions that led to one method sitting in a publicly visible trait and another at least as useful method sitting in an ominously named package private trait, it would be nice if both were equally visible in the scaladoc.
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 the scaladoc pages for cats.syntax.package$$validated$ and ValidatedIdSyntax, then compare how the package-private ValidatedIdOpsBinCompat0 trait is handled. Done means validNec and the other methods from that trait are discoverable in the generated scaladoc alongside validNel.
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