[Python-checkins] cpython (2.7): Issue #18743: Improved cross-references to the StringIO class.

[serhiy.storchaka]

http://hg.python.org/cpython/rev/8c768bbacd92
changeset:   85443:8c768bbacd92
branch:      2.7
parent:      85440:9c66b9cb886b
user:        Serhiy Storchaka <storchaka at gmail.com>
date:        Thu Aug 29 11:44:44 2013 +0300
summary:
  Issue #18743: Improved cross-references to the StringIO class.

files:
  Doc/c-api/typeobj.rst           |  2 +-
  Doc/library/gzip.rst            |  6 +++---
  Doc/library/mailbox.rst         |  2 +-
  Doc/library/mimewriter.rst      |  2 +-
  Doc/library/tempfile.rst        |  2 +-
  Doc/library/xml.dom.minidom.rst |  2 +-
  6 files changed, 8 insertions(+), 8 deletions(-)


diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -199,7 +199,7 @@
    An optional pointer to the instance print function.
 
    The print function is only called when the instance is printed to a *real* file;
-   when it is printed to a pseudo-file (like a :class:`StringIO` instance), the
+   when it is printed to a pseudo-file (like a :class:`~StringIO.StringIO` instance), the
    instance's :c:member:`~PyTypeObject.tp_repr` or :c:member:`~PyTypeObject.tp_str` function is called to convert it to
    a string.  These are also called when the type's :c:member:`~PyTypeObject.tp_print` field is
    *NULL*.  A type should never implement :c:member:`~PyTypeObject.tp_print` in a way that produces
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
--- a/Doc/library/gzip.rst
+++ b/Doc/library/gzip.rst
@@ -33,7 +33,7 @@
    given a non-trivial value.
 
    The new class instance is based on *fileobj*, which can be a regular file, a
-   :class:`StringIO` object, or any other object which simulates a file.  It
+   :class:`~StringIO.StringIO` object, or any other object which simulates a file.  It
    defaults to ``None``, in which case *filename* is opened to provide a file
    object.
 
@@ -65,9 +65,9 @@
 
    Calling a :class:`GzipFile` object's :meth:`close` method does not close
    *fileobj*, since you might wish to append more material after the compressed
-   data.  This also allows you to pass a :class:`StringIO` object opened for
+   data.  This also allows you to pass a :class:`~StringIO.StringIO` object opened for
    writing as *fileobj*, and retrieve the resulting memory buffer using the
-   :class:`StringIO` object's :meth:`getvalue` method.
+   :class:`StringIO` object's :meth:`~StringIO.StringIO.getvalue` method.
 
    :class:`GzipFile` supports iteration and the :keyword:`with` statement.
 
diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst
--- a/Doc/library/mailbox.rst
+++ b/Doc/library/mailbox.rst
@@ -661,7 +661,7 @@
 
       In Babyl mailboxes, the headers of a message are not stored contiguously
       with the body of the message. To generate a file-like representation, the
-      headers and body are copied together into a :class:`StringIO` instance
+      headers and body are copied together into a :class:`~StringIO.StringIO` instance
       (from the :mod:`StringIO` module), which has an API identical to that of a
       file. As a result, the file-like object is truly independent of the
       underlying mailbox but does not save memory compared to a string
diff --git a/Doc/library/mimewriter.rst b/Doc/library/mimewriter.rst
--- a/Doc/library/mimewriter.rst
+++ b/Doc/library/mimewriter.rst
@@ -24,7 +24,7 @@
 
    Return a new instance of the :class:`MimeWriter` class.  The only argument
    passed, *fp*, is a file object to be used for writing. Note that a
-   :class:`StringIO` object could also be used.
+   :class:`~StringIO.StringIO` object could also be used.
 
 
 .. _mimewriter-objects:
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -93,7 +93,7 @@
    causes the file to roll over to an on-disk file regardless of its size.
 
    The returned object is a file-like object whose :attr:`_file` attribute
-   is either a :class:`StringIO` object or a true file object, depending on
+   is either a :class:`~StringIO.StringIO` object or a true file object, depending on
    whether :func:`rollover` has been called. This file-like object can be
    used in a :keyword:`with` statement, just like a normal file.
 
diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst
--- a/Doc/library/xml.dom.minidom.rst
+++ b/Doc/library/xml.dom.minidom.rst
@@ -58,7 +58,7 @@
 .. function:: parseString(string[, parser])
 
    Return a :class:`Document` that represents the *string*. This method creates a
-   :class:`io.StringIO` object for the string and passes that on to :func:`parse`.
+   :class:`~StringIO.StringIO` object for the string and passes that on to :func:`parse`.
 
 Both functions return a :class:`Document` object representing the content of the
 document.

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