diff options
| author | Damien George <damien.p.george@gmail.com> | 2014-10-31 21:30:46 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2014-10-31 21:30:46 +0000 |
| commit | 109c1de015eeee385020233e2f8cc6f921149103 (patch) | |
| tree | 9cd3851ac9b580fcc7d84824bdf14c2bc968ee88 /docs/library | |
| parent | 4029f51842656e7a1576dbe7c41aeea3eef83645 (diff) | |
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.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/gc.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/library/gc.rst b/docs/library/gc.rst index 212fac1db..3e9160f98 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() |