[Python-checkins] cpython (2.7): Issue #13513: IOBase docs incorrectly link to the readline module

meador.inge python-checkins at python.org
Sat Dec 3 19:51:40 CET 2011


http://hg.python.org/cpython/rev/fb8b6d310fb8
changeset:   73826:fb8b6d310fb8
branch:      2.7
parent:      73822:ee94b89f65ab
user:        Meador Inge <meadori at gmail.com>
date:        Sat Dec 03 12:13:42 2011 -0600
summary:
  Issue #13513: IOBase docs incorrectly link to the readline module

files:
  Doc/library/io.rst |  2 +-
  Misc/NEWS          |  3 +++
  2 files changed, 4 insertions(+), 1 deletions(-)


diff --git a/Doc/library/io.rst b/Doc/library/io.rst
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -233,7 +233,7 @@
    :class:`IOBase` object can be iterated over yielding the lines in a stream.
    Lines are defined slightly differently depending on whether the stream is
    a binary stream (yielding :class:`bytes`), or a text stream (yielding
-   :class:`unicode` strings).  See :meth:`readline` below.
+   :class:`unicode` strings).  See :meth:`~IOBase.readline` below.
 
    IOBase is also a context manager and therefore supports the
    :keyword:`with` statement.  In this example, *file* is closed after the
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -430,6 +430,9 @@
 Documentation
 -------------
 
+- Issue #13513: Fix io.IOBase documentation to correctly link to the
+  io.IOBase.readline method instead of the readline module.
+
 - Issue #13237: Reorganise subprocess documentation to emphasise convenience
   functions and the most commonly needed arguments to Popen.
 

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


More information about the Python-checkins mailing list