From 39a5b67d9c43db55d2ed288ebc5ff2b521091be7 Mon Sep 17 00:00:00 2001 From: Richard Date: Sat, 25 Jan 2025 16:19:23 -0800 Subject: [PATCH] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c16762..0bcc5a2 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ Because `effect` implicitly tracks all atoms read within the callback, it might #### Caveats -- **If your effect calls its own cleanup function, use the `cleanup` argument.** Because effects run immediately, your effect will run before a `cleanup` function is returned. To use `cleanup` from with in the effect, use the argument passed to your effect instead: +- **If your effect should disconnect itself, use the `cleanup` argument.** Because effects run immediately, your effect may run before a `cleanup` function is returned. To disconnect an effect from the inside, use the argument passed to your effect instead: ```lua effect(function(cleanup) if condition() then