diff options
author | Fred Drake <fdrake@acm.org> | 2000-09-09 03:26:51 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2000-09-09 03:26:51 (GMT) |
commit | e5441913970871837ab0a43bbf760f285c85f0f6 (patch) | |
tree | 408c19e6eec2b5421fac6003e56cb16e76f45e26 /Doc/lib | |
parent | 1c4efad7707a82ad7edc346b467ecfc84913bee3 (diff) | |
download | cpython-e5441913970871837ab0a43bbf760f285c85f0f6.zip cpython-e5441913970871837ab0a43bbf760f285c85f0f6.tar.gz cpython-e5441913970871837ab0a43bbf760f285c85f0f6.tar.bz2 |
Add \modulesynopsis for inclusion in the list of modules at the beginning
of the chapter.
Add explanation that this is only available when the cycle detector is
enabled at build time.
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/libgc.tex | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex index 9e097ec..5a744c3 100644 --- a/Doc/lib/libgc.tex +++ b/Doc/lib/libgc.tex @@ -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 |