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

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


http://hg.python.org/cpython/rev/9792e812198f
changeset:   73827:9792e812198f
branch:      3.2
parent:      73823:abfe76a19f63
user:        Meador Inge <meadori at gmail.com>
date:        Sat Dec 03 12:29:54 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
@@ -217,7 +217,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 bytes), or a text stream (yielding character
-   strings).  See :meth:`readline` below.
+   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
@@ -316,6 +316,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