From 92f379cce4cd5bc9d07f1ad76cd9674ca02f54e7 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 5 Sep 2023 11:05:47 +1000 Subject: [PATCH] docs/library/gc: Clarify mem_alloc and mem_free only for Python heap. As raised in discussions of the ESP32 memory management changes. Signed-off-by: Angus Gratton --- docs/library/gc.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/library/gc.rst b/docs/library/gc.rst index c823aed3e6..2ba204e229 100644 --- a/docs/library/gc.rst +++ b/docs/library/gc.rst @@ -24,7 +24,7 @@ Functions .. function:: mem_alloc() - Return the number of bytes of heap RAM that are allocated. + Return the number of bytes of heap RAM that are allocated by Python code. .. admonition:: Difference to CPython :class: attention @@ -33,8 +33,8 @@ Functions .. function:: mem_free() - Return the number of bytes of available heap RAM, or -1 if this amount - is not known. + Return the number of bytes of heap RAM that is available for Python + code to allocate, or -1 if this amount is not known. .. admonition:: Difference to CPython :class: attention