This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: [doc] tempfile.TemporaryDirectory documentation improvements
Type: Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Richard Neumann, docs@python, iritkatriel, lars.gustaebel, miss-islington, slateny, xtreak
Priority: normal Keywords: easy, patch

Created on 2018-03-08 10:01 by Richard Neumann, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 32016 merged slateny, 2022-03-20 21:57
PR 32078 closed iritkatriel, 2022-03-23 16:04
PR 32077 merged miss-islington, 2022-03-23 16:17
Messages (2)
msg313431 - (view) Author: Richard Neumann (Richard Neumann) Date: 2018-03-08 10:01
The tempfile.TemporaryDirectory is incorrectly documented at https://docs.python.org/3.6/library/tempfile.html#tempfile.TemporaryDirectory.

It is described as a function, though actually being a class (unlinke tempfile.NamedTemporaryFile).
The respective property "name" and method "cleanup" are only documented in the continuous text but not explicitely highlighted as the properties and method of e.g. TarFile (https://docs.python.org/3/library/tarfile.html#tarfile-objects).
msg322346 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2018-07-25 11:41
On a similar note SpooledTemporaryFile is also documented as a function though it's a class. Ref : https://docs.python.org/3.8/library/tempfile.html#tempfile.SpooledTemporaryFile
History
Date User Action Args
2022-04-11 14:58:58adminsetgithub: 77209
2022-03-23 17:29:02iritkatrielsetstatus: open -> closed
stage: patch review -> resolved
resolution: fixed
versions: - Python 3.9
2022-03-23 16:17:48miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request30166
2022-03-23 16:04:12iritkatrielsetnosy: + iritkatriel
pull_requests: + pull_request30165
2022-03-20 21:57:30slatenysetkeywords: + patch
nosy: + slateny

pull_requests: + pull_request30104
stage: patch review
2022-03-20 19:53:26iritkatrielsetkeywords: + easy
title: tempfile.TemporaryDirectory incorrectly documented -> [doc] tempfile.TemporaryDirectory documentation improvements
versions: + Python 3.9, Python 3.10, Python 3.11, - Python 3.6, Python 3.7, Python 3.8
2018-07-25 11:41:19xtreaksetnosy: + xtreak
messages: + msg322346
2018-03-08 15:20:54ned.deilysettype: enhancement ->
2018-03-08 15:20:20ned.deilysetnosy: + lars.gustaebel

versions: + Python 3.7, Python 3.8
2018-03-08 10:01:02Richard Neumanncreate