aboutsummaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorAngus Gratton <angus@redyak.com.au>2023-09-05 11:05:47 +1000
committerDamien George <damien@micropython.org>2023-09-15 12:19:13 +1000
commit92f379cce4cd5bc9d07f1ad76cd9674ca02f54e7 (patch)
treefc3e011df61a810ec907002da7f2e62878886624 /docs/library
parent26160e8ed54410e3d630c03e1c46eb59e02c2594 (diff)
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 <angus@redyak.com.au>
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/gc.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/gc.rst b/docs/library/gc.rst
index c823aed3e..2ba204e22 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