From e5441913970871837ab0a43bbf760f285c85f0f6 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Sat, 9 Sep 2000 03:26:51 +0000 Subject: [PATCH] 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. --- Doc/lib/libgc.tex | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex index 9e097eca4e8..5a744c3967c 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