[3.11] gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699) (#104703)

gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699)
(cherry picked from commit 30488fa22a)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2023-05-20 13:12:52 -07:00 committed by GitHub
parent 89bd454cd9
commit d45c1df83e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -50,6 +50,9 @@ The :mod:`gc` module provides the following functions:
is run. Not all items in some free lists may be freed due to the is run. Not all items in some free lists may be freed due to the
particular implementation, in particular :class:`float`. particular implementation, in particular :class:`float`.
The effect of calling ``gc.collect()`` while the interpreter is already
performing a collection is undefined.
.. function:: set_debug(flags) .. function:: set_debug(flags)