luckyframework / luckyframework/avram
Add inline documentation
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 183
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
Inline documentation was purposely left off when things were changing, but now the API is starting to stabilize. Adding documentation to the public facing methods would be fantastic.
If you'd like to help, here is how Crystal docs work: https://crystal-lang.org/docs/conventions/documenting_code.html
Feel free to make small PRs so it's easy to review and merge them in :D
Thanks so much for the help!
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 locating the public-facing methods in the Crystal source, then read the linked Crystal documentation conventions. Done means the public API methods have appropriate inline documentation; keep the work in small, reviewable changes as suggested by the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100