Skip to content

Commit 8e01d42

Browse files
committed
DRIVERS.md: Add note re Delay_ms.deinit().
1 parent 197c2b5 commit 8e01d42

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

v3/docs/DRIVERS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1070,7 +1070,9 @@ Synchronous methods:
10701070
the `Task` instance. This allows the `Task` to be cancelled or awaited.
10711071
6. `callback` args `func=None`, `args=()`. Allows the callable and its args to
10721072
be assigned, reassigned or disabled at run time.
1073-
7. `deinit` No args. Cancels the running task. See [Object scope](./TUTORIAL.md#44-object-scope).
1073+
7. `deinit` No args. Cancels the running task. To avoid a memory leak this
1074+
should be called before allowing a `Delay_ms` object to go out of scope. See
1075+
[Object scope](./TUTORIAL.md#44-object-scope).
10741076
8. `clear` No args. Clears the `Event` described in `wait` below.
10751077
9. `set` No args. Sets the `Event` described in `wait` below.
10761078

0 commit comments

Comments
 (0)