typelevel / typelevel/weaver-test
Write proper scaladoc (and validate it)
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 85
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
This issue was copied over from: https://github.com/disneystreaming/weaver-test/issues/252
It was opened by: Baccata
Self explanatory
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
No source file, test, or validation entry point is named. Start by surveying the Scala sources and build configuration to identify the public API documentation and existing Scaladoc validation; done means the relevant APIs have complete Scaladoc and the documentation validation succeeds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100