Add StateT and trampolining to State documentation
Open
Nobody has claimed this yet.
documentation
low-hanging fruit
ready
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
Documentation for State was added in #384. However, it still has a TODO at the end for documenting how StateT relates to State and how/why trampolining is used for State. This TODO should be replaced with documentation.
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 State documentation added in #384 and locate the TODO at its end. Document how StateT relates to State and how and why trampolining is used for State, then verify that the TODO has been replaced with clear explanations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100