Skip to content

Commit b0da5cb

Browse files
projectgusdpgeorge
authored andcommitted
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>
1 parent c309206 commit b0da5cb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/library/gc.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Functions
2424

2525
.. function:: mem_alloc()
2626

27-
Return the number of bytes of heap RAM that are allocated.
27+
Return the number of bytes of heap RAM that are allocated by Python code.
2828

2929
.. admonition:: Difference to CPython
3030
:class: attention
@@ -33,8 +33,8 @@ Functions
3333

3434
.. function:: mem_free()
3535

36-
Return the number of bytes of available heap RAM, or -1 if this amount
37-
is not known.
36+
Return the number of bytes of heap RAM that is available for Python
37+
code to allocate, or -1 if this amount is not known.
3838

3939
.. admonition:: Difference to CPython
4040
:class: attention

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy