[issue33804] Document the default value of the size parameter of io.TextIOBase.read
New submission from Andrés Delfino <adelfino@gmail.com>: Documentation of io.TextIOBase.read makes it look like the size parameter is required. Attached PR fixes this. ---------- assignee: docs@python components: Documentation messages: 319003 nosy: adelfino, docs@python priority: normal severity: normal status: open title: Document the default value of the size parameter of io.TextIOBase.read type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Change by Andrés Delfino <adelfino@gmail.com>: ---------- keywords: +patch pull_requests: +7138 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: What about other methods and other classes? ---------- nosy: +benjamin.peterson, serhiy.storchaka, stutzbach _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Andrés Delfino <adelfino@gmail.com> added the comment: I do see your point (not bloat BPO with a one line fix per each undocumented feature), but IMHO it's somewhat unrealistic to fix all issues of the same type in a single PR. I opened this PR because I was reading this particular function and noticed that the "size" parameter is documented as required. If it was documented as optional, the default value is not documented either. Perhaps we can compromise, and I can look at all the classes/functions in "io", and improve this PR? I cannot propose myself to do this to the whole Python documentation at once :/ Excuse me if I didn't interpret your comment right. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: New changeset b6bb77c2b8e83ba6cb845c7b512ac564276e854f by Serhiy Storchaka (Andrés Delfino) in branch 'master': bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510) https://github.com/python/cpython/commit/b6bb77c2b8e83ba6cb845c7b512ac564276... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +7724 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +7725 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: I see. The real problem was that the argument for io.TextIOBase.read() was not documented as optional. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Change by Andrés Delfino <adelfino@gmail.com>: ---------- pull_requests: +7728 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset e5b47ea5859522f81599a82d49175f6fad263482 by Miss Islington (bot) in branch '3.7': bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510) https://github.com/python/cpython/commit/e5b47ea5859522f81599a82d49175f6fad2... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 770937b6fd87af91390ac765f6a4c4767432cbc3 by Miss Islington (bot) in branch '3.6': bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510) https://github.com/python/cpython/commit/770937b6fd87af91390ac765f6a4c476743... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: New changeset ad0fc8ddba0e2f6715dc14c74cb4dbd437b3777d by Serhiy Storchaka (Andrés Delfino) in branch '2.7': [2.7] bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510). (GH-8171) https://github.com/python/cpython/commit/ad0fc8ddba0e2f6715dc14c74cb4dbd437b... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
Change by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33804> _______________________________________
participants (3)
-
Andrés Delfino -
miss-islington
-
Serhiy Storchaka