From: Armin Rigo <arigo@tunes.org>
Date: Tue, 28 Oct 2003 12:10:38 +0000 (+0000)
Subject: Documented gc.get_referrers() as dangerous.
X-Git-Tag: v2.4a1~1354
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3be6d5d3204165247d0fd0751797c5c9ee4fbc1d;p=python

Documented gc.get_referrers() as dangerous.
SF bug 793822
---

diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex
index 24775849f7..f256434a40 100644
--- a/Doc/lib/libgc.tex
+++ b/Doc/lib/libgc.tex
@@ -96,6 +96,11 @@ be listed among the resulting referrers.  To get only currently live
 objects, call \function{collect()} before calling
 \function{get_referrers()}.
 
+Care must be taken when using objects returned by
+\function{get_referrers()} because some of them could still be under
+construction and hence in a temporarily invalid state. Avoid using
+\function{get_referrers()} for any purpose other than debugging.
+
 \versionadded{2.2}
 \end{funcdesc}