From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 20 May 2023 20:12:52 +0000 (-0700)
Subject: [3.11] gh-49174: document that the effect of calling gc.collect() during a collection... 
X-Git-Tag: v3.11.4~46
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d45c1df83ee89882b50d0a48b190d87767038848;p=thirdparty%2FPython%2Fcpython.git

[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 30488fa22a8f63753192ae7f1d01665857764e45)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
---

diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 42bb6dc3503f..5c2d0bbe0035 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)