typelevel / typelevel/cats-effect
dispatcher document warning about bounded queue
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
using a bounded queue with dispatcher.unsafeRunAndForget doesn't propagate back pressure and the dispatcher list of registrations will still grow unboundedly
the dispatcher docs use unsafeRunAndForget with an unbounded queue in the example, and it doesn't mention the bounding issue. A note or warning about that would be helpful
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 reading the dispatcher documentation and its example using unsafeRunAndForget with an unbounded queue. Update the documentation to warn that using a bounded queue does not propagate back pressure and that dispatcher registrations can still grow without bound. Done means the warning is clear in the relevant example or surrounding text.
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
- Mostly clear
- Newbie friendliness
- 48/100