From 4740c556ba230b28b0b83305e6e64dbc372331e4 Mon Sep 17 00:00:00 2001 From: Thanh Le Date: Mon, 28 Oct 2024 17:52:24 +0100 Subject: [PATCH] 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).