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

[iritkatriel]

https://github.com/python/cpython/commit/30488fa22a8f63753192ae7f1d01665857764e45
commit: 30488fa22a8f63753192ae7f1d01665857764e45
branch: main
author: Irit Katriel <1055913+iritkatriel at users.noreply.github.com>
committer: iritkatriel <1055913+iritkatriel at users.noreply.github.com>
date: 2023-05-20T21:12:10+01:00
summary:

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

files:
M Doc/library/gc.rst

diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst
index 6d5c64df1a1f..0961ca4aaa94 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)