[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Serhiy Storchaka]

Change by Serhiy Storchaka :


--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Serhiy Storchaka]

Serhiy Storchaka  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/ad0fc8ddba0e2f6715dc14c74cb4dbd437b3777d


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[miss-islington]

miss-islington  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/770937b6fd87af91390ac765f6a4c4767432cbc3


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[miss-islington]

miss-islington  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/e5b47ea5859522f81599a82d49175f6fad263482


--
nosy: +miss-islington

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Andrés Delfino]

Change by Andrés Delfino :


--
pull_requests: +7728

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

I see. The real problem was that the argument for io.TextIOBase.read() was not 
documented as optional.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[miss-islington]

Change by miss-islington :


--
pull_requests: +7725

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[miss-islington]

Change by miss-islington :


--
pull_requests: +7724

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Serhiy Storchaka]

Serhiy Storchaka  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/b6bb77c2b8e83ba6cb845c7b512ac564276e854f


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Andrés Delfino]

Andrés Delfino  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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

What about other methods and other classes?

--
nosy: +benjamin.peterson, serhiy.storchaka, stutzbach

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Andrés Delfino]

Change by Andrés Delfino :


--
keywords: +patch
pull_requests: +7138
stage:  -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue33804] Document the default value of the size parameter of io.TextIOBase.read

[Andrés Delfino]

New submission from Andrés Delfino :

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com