Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix joinWithNever docs #4160

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Fix joinWithNever docs #4160

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a7c041
Fix joinWithNever docs
lenguyenthanh Oct 28, 2024
7413d4f
Update docs/typeclasses/spawn.md
lenguyenthanh Nov 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/typeclasses/spawn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ In English, the semantics of this are as follows:

- If the child fiber completed successfully, produce its result
- If it errored, re-raise the error within the current fiber
- If it canceled, attempt to self-cancel, and if the self-cancelation fails, **deadlock**
- If it canceled, the caller is indefinitely suspended without termination (a.k.a. **deadlock**)

Sometimes this is an appropriate semantic, and the cautiously-verbose `joinWithNever` function implements it for you. It is worth noting that this semantic was the *default* in Cats Effect 2 (and in fact, no other semantic was possible).

Expand Down
Loading