This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: IOBase docs incorrectly link to the readline module
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ezio.melotti, meador.inge, python-dev
Priority: normal Keywords: patch

Created on 2011-12-01 04:59 by meador.inge, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
IOBase.readline-doc.patch meador.inge, 2011-12-01 04:59 review
Messages (5)
msg148702 - (view) Author: Meador Inge (meador.inge) * (Python committer) Date: 2011-12-01 04:59
The current IOBase documentation [1] reads:

"""
IOBase (and its subclasses) support the iterator protocol, meaning that an 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 readline() below.
"""

Currently the 'readline' link in the last sentence is linking to the GNU readline interface, which is wrong.  Patch attached.

[1] http://docs.python.org/dev/library/io.html?highlight=readlines#io.IOBase
msg148762 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-12-02 17:13
That’s a known behavior of Sphinx.  Please go ahead and commit.
msg148764 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-12-02 17:21
+1
msg148816 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-12-03 18:51
New changeset fb8b6d310fb8 by Meador Inge in branch '2.7':
Issue #13513: IOBase docs incorrectly link to the readline module
http://hg.python.org/cpython/rev/fb8b6d310fb8

New changeset 9792e812198f by Meador Inge in branch '3.2':
Issue #13513: IOBase docs incorrectly link to the readline module
http://hg.python.org/cpython/rev/9792e812198f

New changeset ab5bc05ac223 by Meador Inge in branch 'default':
Issue #13513: IOBase docs incorrectly link to the readline module
http://hg.python.org/cpython/rev/ab5bc05ac223
msg148817 - (view) Author: Meador Inge (meador.inge) * (Python committer) Date: 2011-12-03 18:53
Fixed.  Thanks for the review y'all.
History
Date User Action Args
2022-04-11 14:57:24adminsetgithub: 57722
2011-12-03 18:53:37meador.ingesetstatus: open -> closed
resolution: fixed
messages: + msg148817

stage: commit review -> resolved
2011-12-03 18:51:41python-devsetnosy: + python-dev
messages: + msg148816
2011-12-02 17:21:12ezio.melottisetnosy: + ezio.melotti

messages: + msg148764
stage: patch review -> commit review
2011-12-02 17:13:58eric.araujosetversions: + Python 2.7
2011-12-02 17:13:48eric.araujosetnosy: + eric.araujo

messages: + msg148762
title: IOBase docs incorrectly link to the GNU readline module -> IOBase docs incorrectly link to the readline module
2011-12-01 04:59:05meador.ingecreate