]> granicus.if.org Git - python/commitdiff
Add \modulesynopsis for inclusion in the list of modules at the beginning
authorFred Drake <fdrake@acm.org>
Sat, 9 Sep 2000 03:26:51 +0000 (03:26 +0000)
committerFred Drake <fdrake@acm.org>
Sat, 9 Sep 2000 03:26:51 +0000 (03:26 +0000)
of the chapter.

Add explanation that this is only available when the cycle detector is
enabled at build time.

Doc/lib/libgc.tex

index 9e097eca4e8348b4a4c26ff7af1aec29bf92caf6..5a744c3967cb1f1e259c652b459b5d9965347a88 100644 (file)
@@ -2,9 +2,15 @@
          Garbage Collector interface}
 
 \declaremodule{extension}{gc}
+\modulesynopsis{Interface to the cycle-detecting garbage collector.}
 \moduleauthor{Neil Schemenauer}{nascheme@enme.ucalgary.ca}
 \sectionauthor{Neil Schemenauer}{nascheme@enme.ucalgary.ca}
 
+The \module{gc} module is only available if the interpreter was built
+with the optional cyclic garbage detector (enabled by default).  If
+this was not enabled, an \exception{ImportError} is raised by attempts
+to import this module.
+
 This module provides an interface to the optional garbage collector.  It
 provides the ability to disable the collector, tune the collection
 frequency, and set debugging options.  It also provides access to