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: Missing default argument detail in documentation of StreamReaderWriter
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: PeterLovett, berker.peksag, docs@python, pablogsal
Priority: normal Keywords: easy, patch

Created on 2017-10-19 23:17 by PeterLovett, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 4328 merged pablogsal, 2017-11-07 22:44
PR 4367 merged python-dev, 2017-11-10 23:06
Messages (7)
msg304646 - (view) Author: Peter Lovett (PeterLovett) * Date: 2017-10-19 23:17
Documentation of StreamReaderWriter at
https://docs.python.org/3/library/codecs.html#codecs.StreamReaderWriter
section 7.2.1.4.3 is missing the default value on the errors argument.

Should change from:
class codecs.StreamReaderWriter(stream, Reader, Writer, errors)
to be:
class codecs.StreamReaderWriter(stream, Reader, Writer, errors='strict')
msg305793 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-11-07 21:43
For those who want to work on this issue: codecs.StreamReaderWriter documentation is located at Doc/library/codecs.rst.
msg305856 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-11-08 15:26
Thanks for the PR, Pablo. I think we can make the same change to StreamRecoder documentation too: https://docs.python.org/3/library/codecs.html#codecs.StreamRecoder
msg306051 - (view) Author: Pablo Galindo Salgado (pablogsal) * (Python committer) Date: 2017-11-10 22:14
I have updated the PR with the requested changes.
msg306055 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-11-10 23:05
New changeset e184cfd7bf8bcfd160e3b611d4351ca3ce52d9e2 by Berker Peksag (Pablo Galindo) in branch 'master':
bpo-31824: Document default value of 'errors' parameters (GH-4328)
https://github.com/python/cpython/commit/e184cfd7bf8bcfd160e3b611d4351ca3ce52d9e2
msg306057 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-11-10 23:14
New changeset 7abbddd88d4debe75b201145b6212afb7d93c457 by Berker Peksag (Miss Islington (bot)) in branch '3.6':
bpo-31824: Document default value of 'errors' parameters (GH-4328)
https://github.com/python/cpython/commit/7abbddd88d4debe75b201145b6212afb7d93c457
msg306058 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-11-10 23:14
Thank you, Peter and Pablo.
History
Date User Action Args
2022-04-11 14:58:53adminsetgithub: 76005
2017-11-10 23:14:37berker.peksagsetstatus: open -> closed
resolution: fixed
messages: + msg306058

stage: patch review -> resolved
2017-11-10 23:14:02berker.peksagsetmessages: + msg306057
2017-11-10 23:06:22python-devsetpull_requests: + pull_request4320
2017-11-10 23:05:18berker.peksagsetmessages: + msg306055
2017-11-10 22:14:45pablogsalsetmessages: + msg306051
2017-11-08 15:26:05berker.peksagsetnosy: + pablogsal
messages: + msg305856
2017-11-07 22:44:49pablogsalsetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request4284
2017-11-07 21:43:14berker.peksagsetversions: + Python 3.7
nosy: + berker.peksag

messages: + msg305793

keywords: + easy
stage: needs patch
2017-10-19 23:17:42PeterLovettcreate