From: slateny <46876382+slateny@users.noreply.github.com> Date: Wed, 23 Mar 2022 14:39:07 +0000 (-0700) Subject: Correctly document class instead of function (GH-32016) X-Git-Tag: v3.11.0a7~150 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=624e3986fbf8467772e4863b7ec004e65adff619;p=thirdparty%2FPython%2Fcpython.git Correctly document class instead of function (GH-32016) --- diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst index 3184e5048842..c97d119fb8b5 100644 --- a/Doc/library/tempfile.rst +++ b/Doc/library/tempfile.rst @@ -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