["Request"] Do a pass on documentation, and examples in KDoc
- Dominant language
- Kotlin
- Stars
- 6.6k
- Forks
- 472
- Avg merge
- 3d 49m
- Merged PRs (30d)
- 4
Description
What version are you currently using?
1.2.0-RC
What would you like to see?
> The KDoc is minimal and lacks examples. For example, on raise() we have just "Raise a logical failure of type Error". Btw GPT-4 generate killer docs if you give him some context and good prompts - ofc it needs human verification but it can greatly speed-up the docs process.
https://kotlinlang.slack.com/archives/C5UPMM0A0/p1680904729946789
Contributor guide
Research direction
Start by locating the KDoc for the raise() entry point and review the surrounding public KDoc for missing explanations and examples. Done means the relevant documentation has been expanded with verified examples and the wording accurately reflects the API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100