mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-10 11:00:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Correct warnings when building the docs for the nonexistet :arg: role. Changed to asterisks.

Browse source
This commit is contained in:
Brian Curtin 2012-04-16 15:24:02 -05:00
parent bd43974037
commit c07bda0a5a
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/gc.rst
View file

@ -187,23 +187,23 @@ values but should not rebind them):
A list of callbacks that will be invoked by the garbage collector before and A list of callbacks that will be invoked by the garbage collector before and
after collection. The callbacks will be called with two arguments, after collection. The callbacks will be called with two arguments,
:arg:`phase` and :arg:`info`. *phase* and *info*.
:arg:`phase` can one of two values: *phase* can one of two values:
"start": The garbage collection is about to start. "start": The garbage collection is about to start.
"stop": The garbage collection has finished. "stop": The garbage collection has finished.
:arg:`info` provides more information for the callback. The following *info* provides more information for the callback. The following
keys are currently defined: keys are currently defined:
"generation": The oldest generation being collected. "generation": The oldest generation being collected.
"collected": When :arg:`phase` is "stop", the number of objects "collected": When *phase* is "stop", the number of objects
successfully collected. successfully collected.
"uncollectable": when :arg:`phase` is "stop", the number of objects "uncollectable": when *phase* is "stop", the number of objects
that could not be collected and were put in :data:`garbage`. that could not be collected and were put in :data:`garbage`.
Applications can add their own callbacks to this list. The primary Applications can add their own callbacks to this list. The primary