[Python-checkins] python/dist/src/Doc/lib libgc.tex,1.11,1.12

[tim_one@users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv2197/python/Doc/lib

Modified Files:
	libgc.tex 
Log Message:
Finished implementing gc.get_referrents():  dealt with error and end
cases, wrote docs, added a test.


Index: libgc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libgc.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** libgc.tex	10 Jul 2002 19:21:07 -0000	1.11
--- libgc.tex	8 Apr 2003 16:39:38 -0000	1.12
***************
*** 100,103 ****
--- 100,116 ----
  \end{funcdesc}
  
+ \begin{funcdesc}{get_referrents}{*objs}
+ Return a list of objects directly referred to by any of the arguments.
+ The referrents returned are those objects visited by the arguments'
+ C-level \cfunction{tp_traverse} methods (if any), and may not be all
+ objects actually directly reachable.  \cfunction{tp_traverse} methods
+ are supported only by objects that support garbage collection, and are
+ only required to visit objects that may be involved in a cycle.  So,
+ for example, if an integer is directly reachable from an argument, that
+ integer object may or may not appear in the result list.
+ 
+ \versionadded{2.3}
+ \end{funcdesc}
+ 
  The following variable is provided for read-only access (you can
  mutate its value but should not rebind it):