Skip to content

Fix MonadCancel scaladoc#4629

Merged
djspiewak merged 3 commits into
typelevel:series/3.7.xfrom
reardonj:3994-monad-cancel-docs
Jul 17, 2026
Merged

Fix MonadCancel scaladoc#4629
djspiewak merged 3 commits into
typelevel:series/3.7.xfrom
reardonj:3994-monad-cancel-docs

Conversation

@reardonj

@reardonj reardonj commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Fixes #3994

  • clarify that observation of cancelation is not guaranteed
  • be more specific about difference between requesting cancelation, observing cancelation and a fiber actually being canceled.
  • clarify that there is a cancelation boundary before a fiber executes anything
  • remove incorrect exceptions to cancelation boundary checks
  • move law violation discussion to the bottom
  • fix IO and Async docs to be clear that never can be canceled

Fixes typelevel#3994

- clarify that observation of cancelation is not guaranteed
- be more specific about difference between requesting cancelation, observing cancelation and a fiber actually being canceled.
- clarify that there is a cancelation boundary before a fiber executes anything
- remove incorrect exceptions to cancelation boundary checks
- move law violation discussion to the bottom
@reardonj
reardonj marked this pull request as ready for review July 4, 2026 15:51
@armanbilge
armanbilge requested review from armanbilge and Copilot and removed request for Copilot July 7, 2026 20:11
@reardonj reardonj mentioned this pull request Jul 10, 2026
3 tasks
Comment thread kernel/shared/src/main/scala/cats/effect/kernel/MonadCancel.scala Outdated
Comment thread kernel/shared/src/main/scala/cats/effect/kernel/MonadCancel.scala Outdated
Comment thread kernel/shared/src/main/scala/cats/effect/kernel/MonadCancel.scala Outdated
Comment thread kernel/shared/src/main/scala/cats/effect/kernel/MonadCancel.scala Outdated
Comment thread kernel/shared/src/main/scala/cats/effect/kernel/MonadCancel.scala Outdated
- mention that there is a boundary before each combinator
- remove reference to IO implementation details, there is no runloop here.
- reorganize Cancelation Boundaries section
@reardonj
reardonj requested a review from durban July 10, 2026 17:54
@djspiewak
djspiewak merged commit 45a4291 into typelevel:series/3.7.x Jul 17, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants