summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2002-01-26 20:11:50 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2002-01-26 20:11:50 (GMT)
commitef180dc3d0254264c71436358f4b2ecf73cfeb6e (patch)
treee3b072c8ac2602cb14b171ecd343b78ec9a74823 /Doc
parentfb0da9d7709057695087f8ca280904c9ef84b11f (diff)
downloadcpython-ef180dc3d0254264c71436358f4b2ecf73cfeb6e.zip
cpython-ef180dc3d0254264c71436358f4b2ecf73cfeb6e.tar.gz
cpython-ef180dc3d0254264c71436358f4b2ecf73cfeb6e.tar.bz2
Document that get_referrers can return unreachable but uncollected objects.
Fixes #505453.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libgc.tex7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/lib/libgc.tex b/Doc/lib/libgc.tex
index b332fe2..67ac64f 100644
--- a/Doc/lib/libgc.tex
+++ b/Doc/lib/libgc.tex
@@ -83,6 +83,13 @@ Return the list of objects that directly refer to any of objs. This
function will only locate those containers which support garbage
collection; extension types which do refer to other objects but do not
support garbage collection will not be found.
+
+Note that objects which have already been dereferenced, but which live
+in cycles and have not yet been collected by the garbage collector can
+be listed among the resulting referrers. To get only currently live
+objects, call \function{collect()} before calling
+\function{get_referrers()}.
+
\versionadded{2.2}
\end{funcdesc}