[py-svn] r36377 - in py/dist/py: documentation path/svn

[cfbolz at codespeak.net]

Author: cfbolz
Date: Tue Jan  9 17:32:25 2007
New Revision: 36377

Modified:
   py/dist/py/documentation/TODO.txt
   py/dist/py/path/svn/urlcommand.py
   py/dist/py/path/svn/wccommand.py
Log:
some more docstrings. update missing list.


Modified: py/dist/py/documentation/TODO.txt
==============================================================================
--- py/dist/py/documentation/TODO.txt	(original)
+++ py/dist/py/documentation/TODO.txt	Tue Jan  9 17:32:25 2007
@@ -126,11 +126,9 @@
 Missing docstrings
 ------------------
 
-code.Traceback misses a docstring
 code.Traceback.recursionindex misses a docstring
 code.Traceback.filter misses a docstring
 code.Traceback.cut misses a docstring
-code.Traceback.__init__ misses a docstring
 code.Traceback.__getitem__ misses a docstring
 code.Traceback.Entry misses a docstring
 code.Traceback.Entry.ishidden misses a docstring
@@ -165,7 +163,6 @@
 execnet.SshGateway.exit misses a docstring
 execnet.SshGateway.__repr__ misses a docstring
 execnet.SshGateway.__init__ misses a docstring
-execnet.SshGateway.ThreadOut misses a docstring
 execnet.SshGateway.ThreadOut.write misses a docstring
 execnet.SshGateway.ThreadOut.setwritefunc misses a docstring
 execnet.SshGateway.ThreadOut.setdefaultwriter misses a docstring
@@ -212,23 +209,10 @@
 magic.View.__matchkey__ misses a docstring
 magic.View.__getattr__ misses a docstring
 magic.AssertionError misses a docstring
-path.svnwc misses a docstring
 path.svnwc.visit misses a docstring
-path.svnwc.revert misses a docstring
-path.svnwc.rename misses a docstring
-path.svnwc.propset misses a docstring
-path.svnwc.proplist misses a docstring
-path.svnwc.propget misses a docstring
-path.svnwc.propdel misses a docstring
-path.svnwc.new misses a docstring
 path.svnwc.mkdir misses a docstring
-path.svnwc.log misses a docstring
-path.svnwc.getpycodeobj misses a docstring
 path.svnwc.dump misses a docstring
-path.svnwc.diff misses a docstring
-path.svnwc.copy misses a docstring
 path.svnwc.check misses a docstring
-path.svnwc.blame misses a docstring
 path.svnwc.add misses a docstring
 path.svnwc.__str__ misses a docstring
 path.svnwc.__repr__ misses a docstring
@@ -241,10 +225,7 @@
 path.svnwc.__cmp__ misses a docstring
 path.svnwc.__add__ misses a docstring
 path.svnwc.Checkers misses a docstring
-path.svnurl misses a docstring
 path.svnurl.visit misses a docstring
-path.svnurl.log misses a docstring
-path.svnurl.getpycodeobj misses a docstring
 path.svnurl.check misses a docstring
 path.svnurl.__repr__ misses a docstring
 path.svnurl.__new__ misses a docstring
@@ -258,9 +239,6 @@
 path.svnurl.Checkers misses a docstring
 path.local.visit misses a docstring
 path.local.sysexec has an 'XXX' in its docstring
-path.local.getpymodule misses a docstring
-path.local.getpycodeobj misses a docstring
-path.local.copy misses a docstring
 path.local.check misses a docstring
 path.local.__repr__ misses a docstring
 path.local.__iter__ misses a docstring
@@ -627,4 +605,3 @@
 xml.Tag.__repr__ misses a docstring
 xml.Tag.__init__ misses a docstring
 xml.Namespace misses a docstring
-

Modified: py/dist/py/path/svn/urlcommand.py
==============================================================================
--- py/dist/py/path/svn/urlcommand.py	(original)
+++ py/dist/py/path/svn/urlcommand.py	Tue Jan  9 17:32:25 2007
@@ -15,6 +15,9 @@
 DEBUG=False 
 
 class SvnCommandPath(svncommon.SvnPathBase):
+    """ path implementation that offers access to (possibly remote) subversion
+    repositories. """
+
     _lsrevcache = BuildcostAccessCache(maxentries=128)
     _lsnorevcache = AgingCache(maxentries=1000, maxseconds=60.0)
 
@@ -203,6 +206,11 @@
             return self._lsnorevcache.getorbuild(self.strpath, builder)
 
     def log(self, rev_start=None, rev_end=1, verbose=False):
+        """ return a list of LogEntry instances for this path.
+rev_start is the starting revision (defaulting to the first one).
+rev_end is the last revision (defaulting to HEAD).
+if verbose is True, then the LogEntry instances also know which files changed.
+"""
         assert self.check() #make it simpler for the pipe
         rev_start = rev_start is None and _Head or rev_start
         rev_end = rev_end is None and _Head or rev_end

Modified: py/dist/py/path/svn/wccommand.py
==============================================================================
--- py/dist/py/path/svn/wccommand.py	(original)
+++ py/dist/py/path/svn/wccommand.py	Tue Jan  9 17:32:25 2007
@@ -19,6 +19,10 @@
 rex_blame = re.compile(r'\s*(\d+)\s*(\S+) (.*)')
 
 class SvnWCCommandPath(common.FSPathBase):
+    """ path implementation offering access/modification to svn working copies.
+        It has methods similar to the functions in os.path and similar to the
+        commands of the svn client.
+    """
     sep = os.sep
 
     def __new__(cls, wcpath=None):