mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 11:08:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

Correctly document class instead of function (GH-32016)

Browse source
This commit is contained in:
slateny 2022-03-23 07:39:07 -07:00 • committed by GitHub
parent b0f886d1bc
commit 624e3986fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/tempfile.rst
View file

@ -99,9 +99,9 @@ The module defines the following user-callable items:
Added *errors* parameter. 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 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 until the file's :func:`fileno` method is called, at which point the
contents are written to disk and operation proceeds as with 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. 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 The resulting object can be used as a context manager (see
:ref:`tempfile-examples`). On completion of the context or destruction :ref:`tempfile-examples`). On completion of the context or destruction
of the temporary directory object, the newly created temporary directory of the temporary directory object, the newly created temporary directory