summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIrit Katriel <1055913+iritkatriel@users.noreply.github.com>2023-05-20 20:12:10 (GMT)
committerGitHub <noreply@github.com>2023-05-20 20:12:10 (GMT)
commit30488fa22a8f63753192ae7f1d01665857764e45 (patch)
treecdab89720a63800bbea214470a2bb1f3be96c5c0
parentd1732feea0eadd4ccc3516440d0c071be0093dec (diff)
downloadcpython-30488fa22a8f63753192ae7f1d01665857764e45.zip
cpython-30488fa22a8f63753192ae7f1d01665857764e45.tar.gz
cpython-30488fa22a8f63753192ae7f1d01665857764e45.tar.bz2
gh-49174: document that the effect of calling gc.collect() during a collection is undefined (#104699)
-rw-r--r--Doc/library/gc.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 6d5c64d..0961ca4 100644
--- a/Doc/library/gc.rst
+++ b/Doc/library/gc.rst
@@ -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
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)