Issue 33804: Document the default value of the size parameter of io.TextIOBase.read
Created on 2018-06-08 00:51 by adelfino, last changed 2022-04-11 14:59 by admin. This issue is now closed.
| Pull Requests | |||
|---|---|---|---|
| URL | Status | Linked | Edit |
| PR 7510 | merged | adelfino, 2018-06-08 00:51 | |
| PR 8167 | merged | miss-islington, 2018-07-07 20:18 | |
| PR 8168 | merged | miss-islington, 2018-07-07 20:20 | |
| PR 8171 | merged | adelfino, 2018-07-07 20:37 | |
| Messages (8) | |||
|---|---|---|---|
| msg319003 - (view) | Author: Andrés Delfino (adelfino) *  |
Date: 2018-06-08 00:51 | |
Documentation of io.TextIOBase.read makes it look like the size parameter is required. Attached PR fixes this. |
|||
| msg321230 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) *  |
Date: 2018-07-07 19:35 | |
What about other methods and other classes? |
|||
| msg321231 - (view) | Author: Andrés Delfino (adelfino) * |
Date: 2018-07-07 20:05 | |
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. |
|||
| msg321232 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2018-07-07 20:17 | |
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/b6bb77c2b8e83ba6cb845c7b512ac564276e854f |
|||
| msg321233 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2018-07-07 20:23 | |
I see. The real problem was that the argument for io.TextIOBase.read() was not documented as optional. |
|||
| msg321235 - (view) | Author: miss-islington (miss-islington) | Date: 2018-07-07 20:39 | |
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/e5b47ea5859522f81599a82d49175f6fad263482 |
|||
| msg321236 - (view) | Author: miss-islington (miss-islington) | Date: 2018-07-07 20:45 | |
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/770937b6fd87af91390ac765f6a4c4767432cbc3 |
|||
| msg321239 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2018-07-07 21:10 | |
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/ad0fc8ddba0e2f6715dc14c74cb4dbd437b3777d |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:59:01 | admin | set | github: 77985 |
| 2018-07-07 21:11:27 | serhiy.storchaka | set | status: open -> closed resolution: fixed stage: patch review -> resolved |
| 2018-07-07 21:10:20 | serhiy.storchaka | set | messages: + msg321239 |
| 2018-07-07 20:45:10 | miss-islington | set | messages: + msg321236 |
| 2018-07-07 20:39:06 | miss-islington | set | nosy:
+ miss-islington messages: + msg321235 |
| 2018-07-07 20:37:29 | adelfino | set | pull_requests: + pull_request7728 |
| 2018-07-07 20:23:12 | serhiy.storchaka | set | messages: + msg321233 |
| 2018-07-07 20:20:28 | miss-islington | set | pull_requests: + pull_request7725 |
| 2018-07-07 20:18:39 | miss-islington | set | pull_requests: + pull_request7724 |
| 2018-07-07 20:17:19 | serhiy.storchaka | set | messages: + msg321232 |
| 2018-07-07 20:05:16 | adelfino | set | messages: + msg321231 |
| 2018-07-07 19:35:20 | serhiy.storchaka | set | nosy:
+ stutzbach, serhiy.storchaka, benjamin.peterson messages: + msg321230 |
| 2018-06-08 00:51:59 | adelfino | set | keywords:
+ patch stage: patch review pull_requests: + pull_request7138 |
| 2018-06-08 00:51:37 | adelfino | create | |