[Python-checkins] Correctly document class instead of function (GH-32016)
miss-islington
webhook-mailer at python.org
Wed Mar 23 12:18:05 EDT 2022
https://github.com/python/cpython/commit/4298114e1d6ff2063a0d4b8a6cf191b59b418975
commit: 4298114e1d6ff2063a0d4b8a6cf191b59b418975
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-03-23T09:17:53-07:00
summary:
Correctly document class instead of function (GH-32016)
(cherry picked from commit 624e3986fbf8467772e4863b7ec004e65adff619)
Co-authored-by: slateny <46876382+slateny at users.noreply.github.com>
files:
M Doc/library/tempfile.rst
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
index 6b23a1bcd630b..30491d48e10ef 100644
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -96,9 +96,9 @@ The module defines the following user-callable items:
Added *errors* parameter.
-.. function:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)
+.. class:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)
- This function operates exactly as :func:`TemporaryFile` does, except that
+ This class operates exactly as :func:`TemporaryFile` does, except that
data is spooled in memory until the file size exceeds *max_size*, or
until the file's :func:`fileno` method is called, at which point the
contents are written to disk and operation proceeds as with
@@ -121,9 +121,9 @@ The module defines the following user-callable items:
Added *errors* parameter.
-.. function:: TemporaryDirectory(suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False)
+.. class:: TemporaryDirectory(suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False)
- This function securely creates a temporary directory using the same rules as :func:`mkdtemp`.
+ This class securely creates a temporary directory using the same rules as :func:`mkdtemp`.
The resulting object can be used as a context manager (see
:ref:`tempfile-examples`). On completion of the context or destruction
of the temporary directory object, the newly created temporary directory
More information about the Python-checkins
mailing list