]> granicus.if.org Git - python/commitdiff
Issue #13513: IOBase docs incorrectly link to the readline module
authorMeador Inge <meadori@gmail.com>
Sat, 3 Dec 2011 18:29:54 +0000 (12:29 -0600)
committerMeador Inge <meadori@gmail.com>
Sat, 3 Dec 2011 18:29:54 +0000 (12:29 -0600)
Doc/library/io.rst
Misc/NEWS

index 4da61957a1c4101b2e27b41ec56280a6775abd5a..972820cfcccffbd3be9a39fa23c7b59bb0e57e57 100644 (file)
@@ -217,7 +217,7 @@ I/O Base Classes
    :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
index b9700e94cf8ab1223fc7078e4a819a439ab9f306..c5324644d4eaa751a1fbb4fe8e22ddb2ca25b4ee 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -316,6 +316,9 @@ Extension Modules
 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.