summaryrefslogtreecommitdiffstats
path: root/Doc/api/api.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/api/api.tex')
-rw-r--r--Doc/api/api.tex5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 5726341..8bf0892 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -5029,6 +5029,11 @@ pair of rules:
objects. The deallocator (\member{tp_dealloc} handler) should call
this for the object before any of the fields used by the
\member{tp_traverse} handler become invalid.
+
+ \strong{Note:} Any container which may be referenced from another
+ object reachable by the collector must itself be tracked by the
+ collector, so it is generally not safe to call this function
+ anywhere but in the object's deallocator.
\end{cfuncdesc}
The \member{tp_traverse} handler accepts a function parameter of this