From 95f0dbf3f3f4dc4f2011c4a33962985ec00d739a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleix=20Conchillo=20Flaqu=C3=A9?= Date: Fri, 31 Jan 2025 18:30:48 -0800 Subject: [PATCH] CHANGELOG.md: task.cancel() and EndFrame clarification --- CHANGELOG.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a26b86df7..1d9a402eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -73,11 +73,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Other -- Updated all examples to use `task.cancel()` instead of pushing an `EndFrame` - when a participant leaves/disconnects. If you push an `EndFrame` this will - cause the bot to run through everything that is internally queued (which could - take seconds). Instead, if a participant disconnects there is nothing else to - be sent and therefore we should stop immediately. +- Updated examples to use `task.cancel()` to immediately exit the example when a + participant leaves or disconnects, instead of pushing an `EndFrame`. Pushing + an `EndFrame` causes the bot to run through everything that is internally + queued (which could take some seconds). Note that using `task.cancel()` might + not always be the best option and pushing an `EndFrame` could still be + desirable to make sure all the pipeline is flushed. ## [0.0.54] - 2025-01-27