typelevel / typelevel/cats-effect
Add FAQ about why to prefer `Dispatcher#unsafeRun` to `IO#unsafeRun`
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
I explained it in https://github.com/typelevel/feral/issues/334#issuecomment-1484533775, maybe just needs to be tidied and move to our FAQ
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 explanation in the linked feral issue comment, then locate the cats-effect FAQ and determine where this guidance belongs. Move and tidy the explanation so it clearly explains why Dispatcher#unsafeRun is preferred to IO#unsafeRun; done means the FAQ contains the rationale in a readable form.
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
- 50/100