From 06b7ba0a5510ce437b8407daa20dbfffc445ccb9 Mon Sep 17 00:00:00 2001 From: Eric Marks <64268853+Eric-A-Marks@users.noreply.github.com> Date: Wed, 17 Mar 2021 09:17:33 -0500 Subject: [PATCH] Update README.md --- events/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/events/README.md b/events/README.md index 9ef90fe3ea..d154f56704 100644 --- a/events/README.md +++ b/events/README.md @@ -75,7 +75,7 @@ queue.call_every(400, printf, "called every 0.4 seconds\n"); The call functions return an ID that uniquely represents the event in the the event queue. You can pass this ID to `EventQueue::cancel` to cancel -an in-flight event. +an in-flight event prior to dispatch. ``` cpp // The event id uniquely represents the event in the queue @@ -88,7 +88,7 @@ if (id) { } // Events can be cancelled as long as they have not been dispatched. If the -// event has already expired, cancel has no side-effects. +// event has already expired, cancel may have negative side-effects. queue.cancel(id); ``` @@ -257,7 +257,7 @@ int enet_consume(void *buffer, int size) { ``` Additionally, in-flight events can be cancelled with `equeue_cancel`. Events -are given unique ids on post, allowing safe cancellation of expired events. +are given unique ids on post, allowing safe cancellation until dispatch. ``` c #include "equeue.h"