svn commit: r1158288 - /subversion/trunk/subversion/bindings/swig/python/svn/repos.py

[da...@apache.org]

Author: danielsh
Date: Tue Aug 16 14:22:17 2011
New Revision: 1158288

URL: http://svn.apache.org/viewvc?rev=1158288&view=rev
Log:
* subversion/bindings/swig/python/svn/repos.py
  (ChangeCollector, ChangeCollector.__init__): Document.

Suggested by: cmpilato

Modified:
    subversion/trunk/subversion/bindings/swig/python/svn/repos.py

Modified: subversion/trunk/subversion/bindings/swig/python/svn/repos.py
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/swig/python/svn/repos.py?rev=1158288&r1=1158287&r2=1158288&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/swig/python/svn/repos.py (original)
+++ subversion/trunk/subversion/bindings/swig/python/svn/repos.py Tue Aug 16 14:22:17 2011
@@ -72,12 +72,28 @@ class ChangedPath:
 
 
 class ChangeCollector(_svndelta.Editor):
-  """Available Since: 1.2.0
+  """An editor that, when driven, walks a revision or a transaction and
+  incrementally invokes a callback with ChangedPath instances corresponding to
+  paths changed in that revision.
+
+  Available Since: 1.2.0
   """
 
   # BATON FORMAT: [path, base_path, base_rev]
 
   def __init__(self, fs_ptr, root, pool=None, notify_cb=None):
+    """Construct a walker over the svn_fs_root_t ROOT, which must
+    be in the svn_fs_t FS_PTR.  Invoke NOTIFY_CB with a single argument
+    of type ChangedPath for each change under ROOT.
+
+    At this time, two ChangedPath objects will be passed for a path that had
+    been replaced in the revision/transaction.  This may change in the future.
+  
+    ### Can't we deduce FS_PTR from ROOT?
+
+    ### POOL is unused
+    """
+
     self.fs_ptr = fs_ptr
     self.changes = { } # path -> ChangedPathEntry()
     self.roots = { } # revision -> svn_svnfs_root_t