djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library/gc.rst

30 lines
645 B
ReStructuredText
Raw Normal View History

docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
:mod:`gc` -- control the garbage collector
==========================================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
.. module:: gc
:synopsis: control the garbage collector
Functions
---------
py: Make gc.enable/disable just control auto-GC; alloc is still allowed. gc.enable/disable are now the same as CPython: they just control whether automatic garbage collection is enabled or not. If disabled, you can still allocate heap memory, and initiate a manual collection.
2014-10-31 17:30:46 -04:00
.. function:: enable()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
py: Make gc.enable/disable just control auto-GC; alloc is still allowed. gc.enable/disable are now the same as CPython: they just control whether automatic garbage collection is enabled or not. If disabled, you can still allocate heap memory, and initiate a manual collection.
2014-10-31 17:30:46 -04:00
Enable automatic garbage collection.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
.. function:: disable()
py: Make gc.enable/disable just control auto-GC; alloc is still allowed. gc.enable/disable are now the same as CPython: they just control whether automatic garbage collection is enabled or not. If disabled, you can still allocate heap memory, and initiate a manual collection.
2014-10-31 17:30:46 -04:00
Disable automatic garbage collection. Heap memory can still be allocated,
and garbage collection can still be initiated manually using :meth:`gc.collect`.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
py: Make gc.enable/disable just control auto-GC; alloc is still allowed. gc.enable/disable are now the same as CPython: they just control whether automatic garbage collection is enabled or not. If disabled, you can still allocate heap memory, and initiate a manual collection.
2014-10-31 17:30:46 -04:00
.. function:: collect()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
py: Make gc.enable/disable just control auto-GC; alloc is still allowed. gc.enable/disable are now the same as CPython: they just control whether automatic garbage collection is enabled or not. If disabled, you can still allocate heap memory, and initiate a manual collection.
2014-10-31 17:30:46 -04:00
Run a garbage collection.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-30 21:37:19 -04:00
.. function:: mem_alloc()
Return the number of bytes of heap RAM that are allocated.
.. function:: mem_free()
Return the number of bytes of available heap RAM.