[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by Vinay Sajip : -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker ___ ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Vinay Sajip added the comment: New changeset c978be283db768743d995f04414c65439a632bdd by Miss Islington (bot) in branch '3.9': bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763) (GH-5)

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by Vinay Sajip : -- versions: -Python 3.7 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Vinay Sajip added the comment: New changeset bf50b0e80a8a0d651af2f953b662eeadd27c7c93 by Miss Islington (bot) in branch '3.8': bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763) (GH-6)

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by Vinay Sajip : -- versions: +Python 3.10, Python 3.9 -Python 3.4, Python 3.5, Python 3.6 ___ Python tracker ___ ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by miss-islington : -- pull_requests: +21280 pull_request: https://github.com/python/cpython/pull/5 ___ Python tracker ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by miss-islington : -- pull_requests: +21281 pull_request: https://github.com/python/cpython/pull/6 ___ Python tracker ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

miss-islington added the comment: New changeset b48389d95093c3f912549add8da339edc164bf0d by Sergey Fedoseev in branch 'master': bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763)

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by Sergey Fedoseev : -- nosy: +sir-sigurd nosy_count: 4.0 -> 5.0 pull_requests: +21279 pull_request: https://github.com/python/cpython/pull/21763 ___ Python tracker ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Antti Haapala added the comment: This week we were bit by this in production. I foolishly thought that the docs would give me correct default values... It is worse that it didn't actually occur until we went over the limit. -- nosy: +ztane ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Martin Falatic added the comment: The correction of `buffering=None` --> `buffering=-1` for the defaults definitely needs to happen. A reference to `open()` is already present in the 3.x documentation: "buffering, encoding and newline are interpreted as for open()."

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Change by Akshay Sharma : -- keywords: +patch pull_requests: +6120 stage: -> patch review ___ Python tracker ___

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

Akshay Sharma added the comment: Hi, will it be good to link the cross-reference for `open`(https://docs.python.org/3/library/functions.html#open) in the documentation? I think specifically mentioning the usage of the `buffering` is a better way. --

[issue33239] tempfile module: functions with the 'buffering' option are incorrectly documented

New submission from Martin Falatic : The documentation for the tempfile module in Python 3.x for the `buffering` option is incorrect: https://docs.python.org/3/library/tempfile.html TemporaryFile, NamedTemporaryFile, and SpooledTemporaryFile all take the `buffering`