Rev 167: Documentation in http://bazaar.launchpad.net/~meliae-dev/meliae/trunk

[John Arbash Meinel]

At http://bazaar.launchpad.net/~meliae-dev/meliae/trunk

------------------------------------------------------------
revno: 167
revision-id: john at arbash-meinel.com-20100729155300-iuvsrugm61e1y9ih
parent: john at arbash-meinel.com-20100729155028-7s18qj51b22v4o08
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: trunk
timestamp: Thu 2010-07-29 10:53:00 -0500
message:
  Documentation
-------------- next part --------------
=== modified file 'CHANGES.txt'
--- a/CHANGES.txt	2010-07-29 14:37:29 +0000
+++ b/CHANGES.txt	2010-07-29 15:53:00 +0000
@@ -18,6 +18,12 @@
   to be useful anyway, better to make it easier to use the useful api.
   (John Arbash Meinel)
 
+* ``obj.iter_recursive_refs()`` can now be used to find all objects
+  referenced from this object (including obj). It can also take an
+  iterable of object addresses to exclude. Which makes it easy to ask,
+  "What objects are accessible from X that aren't accessible from Y?"
+  (John Arbash Meinel)
+
 
 Meliae 0.2.1
 ############

=== modified file 'meliae/_loader.pyx'
--- a/meliae/_loader.pyx	2010-07-29 15:50:28 +0000
+++ b/meliae/_loader.pyx	2010-07-29 15:53:00 +0000
@@ -609,7 +609,8 @@
         """Find all objects referenced from this one (including self).
 
         Self will always be the first object returned, in case you want to
-        exclude it (though it can be excluded in the excluding list).
+        exclude it (though it can be excluded in the excluding list). This is
+        done because it is cumbersome to add it back in, but easy to exclude.
 
         :param excluding: This can be any iterable of addresses. We will not
             walk to anything in this list (including self).