From 3be6d5d3204165247d0fd0751797c5c9ee4fbc1d Mon Sep 17 00:00:00 2001 From: Armin Rigo Date: Tue, 28 Oct 2003 12:10:38 +0000 Subject: Documented gc.get_referrers() as dangerous. SF bug 793822 --- Doc/lib/libgc.tex | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex index 2477584..f256434 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} -- cgit v0.12