typelevel / typelevel/cats-effect
Document most common failure modes when using `Dispatcher`
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
For example, I'm constantly hitting "dispatcher already shutdown" issues, and I always get really confused on why. Some troubleshooting docs would be great.
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 existing documentation for Dispatcher and reviewing how shutdown is described. Identify the most common failure modes, including "dispatcher already shutdown," and document their causes and troubleshooting steps. Done means users can understand why these failures occur and what to do next.
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
- 35/100