diff options
| author | Brian Curtin <brian@python.org> | 2012-04-16 20:24:02 (GMT) |
|---|---|---|
| committer | Brian Curtin <brian@python.org> | 2012-04-16 20:24:02 (GMT) |
| commit | c07bda0a5a1e3f97df3091f7e71598fc41ec3b26 (patch) | |
| tree | 73c4e5fee33c7d5184b3b26994e3c17f095fceb9 /Doc/library/gc.rst | |
| parent | bd4397403783fa9b98f98e15bbb1a39d5710ee04 (diff) | |
| download | cpython-c07bda0a5a1e3f97df3091f7e71598fc41ec3b26.zip cpython-c07bda0a5a1e3f97df3091f7e71598fc41ec3b26.tar.gz cpython-c07bda0a5a1e3f97df3091f7e71598fc41ec3b26.tar.bz2 | |
Correct warnings when building the docs for the nonexistet :arg: role. Changed to asterisks.
Diffstat (limited to 'Doc/library/gc.rst')
| -rw-r--r-- | Doc/library/gc.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index da78aa4..3d76411 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -187,23 +187,23 @@ values but should not rebind them): A list of callbacks that will be invoked by the garbage collector before and 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. "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: "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. - "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`. Applications can add their own callbacks to this list. The primary |