]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Correctly document class instead of function (GH-32016)
authorslateny <46876382+slateny@users.noreply.github.com>
Wed, 23 Mar 2022 14:39:07 +0000 (07:39 -0700)
committerGitHub <noreply@github.com>
Wed, 23 Mar 2022 14:39:07 +0000 (14:39 +0000)
Doc/library/tempfile.rst

index 3184e504884276ad924d6293380d330f27c4af0f..c97d119fb8b5e4b34f61667681bc9655bc03e8d7 100644 (file)
@@ -99,9 +99,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
@@ -124,9 +124,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