From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 16 Feb 2021 00:58:05 +0000 (-0800) Subject: Add a warning block around the get_referrers() documentation (GH-24511) (GH-24544) X-Git-Tag: v3.7.10~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b61b20dba554a74a2f9f0936b16dd669f93a561c;p=thirdparty%2FPython%2Fcpython.git Add a warning block around the get_referrers() documentation (GH-24511) (GH-24544) (cherry picked from commit 813db24f7c2c536d587d1832c3c52b44fa9e242e) Co-authored-by: Pablo Galindo --- diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index 1f09ed52ce86..7ee71dc44627 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -132,10 +132,11 @@ The :mod:`gc` module provides the following functions: resulting referrers. To get only currently live objects, call :func:`collect` before calling :func:`get_referrers`. - Care must be taken when using objects returned by :func:`get_referrers` because - some of them could still be under construction and hence in a temporarily - invalid state. Avoid using :func:`get_referrers` for any purpose other than - debugging. + .. warning:: + Care must be taken when using objects returned by :func:`get_referrers` because + some of them could still be under construction and hence in a temporarily + invalid state. Avoid using :func:`get_referrers` for any purpose other than + debugging. .. function:: get_referents(*objs)