From 5a7c0413be03c11e83fb481cc8e7b9e3234adadb Mon Sep 17 00:00:00 2001 From: Thanh Le Date: Mon, 28 Oct 2024 17:52:24 +0100 Subject: [PATCH 1/2] Fix joinWithNever docs --- docs/typeclasses/spawn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/typeclasses/spawn.md b/docs/typeclasses/spawn.md index e2bf2ac127..4599a08337 100644 --- a/docs/typeclasses/spawn.md +++ b/docs/typeclasses/spawn.md @@ -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). From 7413d4f7ae0e05e75b59e61604e244d4f81a6467 Mon Sep 17 00:00:00 2001 From: Thanh Le Date: Sat, 16 Nov 2024 11:22:44 +0100 Subject: [PATCH 2/2] Update docs/typeclasses/spawn.md Co-authored-by: Daniel Urban --- docs/typeclasses/spawn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/typeclasses/spawn.md b/docs/typeclasses/spawn.md index 4599a08337..4d373a5c89 100644 --- a/docs/typeclasses/spawn.md +++ b/docs/typeclasses/spawn.md @@ -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, the caller is indefinitely suspended without termination(a.k.a **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).