From 109c1de015eeee385020233e2f8cc6f921149103 Mon Sep 17 00:00:00 2001
From: Damien George
Date: Fri, 31 Oct 2014 21:30:46 +0000
Subject: 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.
---
 docs/library/gc.rst | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

(limited to 'docs')

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()
 
-- 
cgit v1.2.3