classification
Title: io documentation refers to newline as newlines
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: abarnert, docs@python, python-dev, zach.ware
Priority: normal Keywords:

Created on 2014-07-18 06:25 by abarnert, last changed 2014-07-18 14:16 by zach.ware. This issue is now closed.

Messages (4)
msg223398 - (view) Author: Andrew Barnert (abarnert) * Date: 2014-07-18 06:25
In at least one place in the io module documentation (io.IOBase.readline), and in the corresponding docstring, the newline parameter to open (and io.open, and io.Foo.__init__) is referred to as "newlines":

> The line terminator is always b'\n' for binary files; for text files, 
> the newlines argument to open() can be used to select the line 
> terminator(s) recognized.

(The newline parameter is closely related to the newlines attribute of the TextIOWrapper that gets created by the open call, but they're not the same thing, and I think were named differently intentionally.)
msg223399 - (view) Author: Andrew Barnert (abarnert) * Date: 2014-07-18 06:28
Searching the source and the help page, it looks like the one example I gave is the only place it's wrong in each of the two, not one of multiple places.
msg223409 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-07-18 14:15
New changeset 4c98086194d5 by Zachary Ware in branch '2.7':
Issue #22004: Correct an argument name.
http://hg.python.org/cpython/rev/4c98086194d5

New changeset 252cd056d1cf by Zachary Ware in branch '3.4':
Issue #22004: Correct an argument name.
http://hg.python.org/cpython/rev/252cd056d1cf

New changeset f83adc06f486 by Zachary Ware in branch 'default':
Closes #22004: Merge with 3.4
http://hg.python.org/cpython/rev/f83adc06f486
msg223410 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2014-07-18 14:16
Fixed! Thanks for the report.
History
Date User Action Args
2014-07-18 14:16:45zach.waresetnosy: + zach.ware

messages: + msg223410
versions: - Python 3.1, Python 3.2, Python 3.3
2014-07-18 14:15:49python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg223409

resolution: fixed
stage: resolved
2014-07-18 06:28:19abarnertsetmessages: + msg223399
2014-07-18 06:25:17abarnertcreate