typelevel / typelevel/cats-effect
Converge on a single nomenclature for fiber blocking in docs
Open
Beginner friendly
Nobody has claimed this yet.
:books: docs
good first issue
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Some of the docs mention "semantic blocking" and some "fiber blocking". In https://typelevel.org/cats-effect/docs/thread-model we mention "Fiber blocking (previously "Semantic Blocking")". So likely we should review and change all instances of "semantic blocking" to "fiber blocking".
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 thread-model documentation page linked in the issue, then search the repository docs for every instance of "semantic blocking" and "fiber blocking". Review each match for context and update the terminology consistently; done means the docs use the agreed nomenclature without unintended references remaining.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100