[Python-checkins] cpython: Correct warnings when building the docs for the nonexistet :arg: role. Changed

brian.curtin python-checkins at python.org
Mon Apr 16 22:24:11 CEST 2012


http://hg.python.org/cpython/rev/a1b38ade5def
changeset:   76364:a1b38ade5def
user:        Brian Curtin <brian at python.org>
date:        Mon Apr 16 15:24:02 2012 -0500
summary:
  Correct warnings when building the docs for the nonexistet :arg: role. Changed to asterisks.

files:
  Doc/library/gc.rst |  10 +++++-----
  1 files changed, 5 insertions(+), 5 deletions(-)


diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -187,23 +187,23 @@
 
    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

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list