[issue31824] Missing default argument detail in documentation of StreamReaderWriter
New submission from Peter Lovett pacqa100@yahoo.com.au:
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')
---------- assignee: docs@python components: Documentation messages: 304646 nosy: PeterLovett, docs@python priority: normal severity: normal status: open title: Missing default argument detail in documentation of StreamReaderWriter type: behavior versions: Python 3.6
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Berker Peksag berker.peksag@gmail.com added the comment:
For those who want to work on this issue: codecs.StreamReaderWriter documentation is located at Doc/library/codecs.rst.
---------- keywords: +easy nosy: +berker.peksag stage: -> needs patch versions: +Python 3.7
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Change by Pablo Galindo Salgado pablogsal@gmail.com:
---------- keywords: +patch pull_requests: +4284 stage: needs patch -> patch review
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Berker Peksag berker.peksag@gmail.com added the comment:
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
---------- nosy: +pablogsal
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Pablo Galindo Salgado pablogsal@gmail.com added the comment:
I have updated the PR with the requested changes.
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Berker Peksag berker.peksag@gmail.com added the comment:
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/e184cfd7bf8bcfd160e3b611d4351ca3ce5...
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Change by Roundup Robot devnull@psf.upfronthosting.co.za:
---------- pull_requests: +4320
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Berker Peksag berker.peksag@gmail.com added the comment:
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/7abbddd88d4debe75b201145b6212afb7d9...
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
Berker Peksag berker.peksag@gmail.com added the comment:
Thank you, Peter and Pablo.
---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue31824 _______________________________________
participants (4)
-
Berker Peksag -
Pablo Galindo Salgado
-
Peter Lovett
-
Roundup Robot