Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Fred Drake 2000-09-09 03:26:51 +00:00
parent 1c4efad770
commit e544191397
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/lib/libgc.tex
View 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