]> granicus.if.org Git - python/commitdiff
Issue #18743: Improved cross-references to the StringIO class.
authorSerhiy Storchaka <storchaka@gmail.com>
Thu, 29 Aug 2013 08:44:44 +0000 (11:44 +0300)
committerSerhiy Storchaka <storchaka@gmail.com>
Thu, 29 Aug 2013 08:44:44 +0000 (11:44 +0300)
Doc/c-api/typeobj.rst
Doc/library/gzip.rst
Doc/library/mailbox.rst
Doc/library/mimewriter.rst
Doc/library/tempfile.rst
Doc/library/xml.dom.minidom.rst

index c35f72770727179d0ab91ffd484599c75908b4b6..bc596cca8fa909d43eeefefe0763c3f1b80ca849 100644 (file)
@@ -199,7 +199,7 @@ type objects) *must* have the :attr:`ob_size` field.
    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
index ce11eec1cc221bc1e95a0873a45a8e3479193703..4dd479ecf0634b6d44327e977f8dd5fbc540006d 100644 (file)
@@ -33,7 +33,7 @@ The module defines the following items:
    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 @@ The module defines the following items:
 
    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.
 
index 3a87c13ff8a98505de2831217e7c6a53ece366b8..c01656403ed84e08713a49e0010f47f02aa14a44 100644 (file)
@@ -661,7 +661,7 @@ Maildir, mbox, MH, Babyl, and MMDF.
 
       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
index 2070ff614d73e2b90a671e4f23820b7e9856b197..a30caef48316820ac79bdd54979b984103730d39 100644 (file)
@@ -24,7 +24,7 @@ to rearrange their order.
 
    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:
index ada647daa31f5070bb32e4d5560b887fafc04ab9..827f5f59baa02135049ebcd9a19a7e3d564e86f6 100644 (file)
@@ -93,7 +93,7 @@ The module defines the following user-callable functions:
    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.
 
index f6984a01112390cd91cc3b10fb95644762228c7b..d4e363ac0204f0693cee5b4c613c53d31ece0f98 100644 (file)
@@ -58,7 +58,7 @@ instead:
 .. 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.