summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/gc.rst13
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/library/gc.rst b/docs/library/gc.rst
index 212fac1db8..3e9160f98d 100644
--- a/docs/library/gc.rst
+++ b/docs/library/gc.rst
@@ -4,22 +4,21 @@
.. module:: gc
:synopsis: control the garbage collector
-
-
Functions
---------
-.. function:: collect()
+.. function:: enable()
- Run a garbage collection.
+ Enable automatic garbage collection.
.. function:: disable()
- Disable the garbage collector.
+ Disable automatic garbage collection. Heap memory can still be allocated,
+ and garbage collection can still be initiated manually using :meth:`gc.collect`.
-.. function:: enable()
+.. function:: collect()
- Enable the garbage collector.
+ Run a garbage collection.
.. function:: mem_alloc()