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

[cfbolz at codespeak.net]

Author: cfbolz
Date: Tue Jan  9 12:40:11 2007
New Revision: 36337

Modified:
   py/dist/py/documentation/TODO.txt
   py/dist/py/path/svn/urlcommand.py
   py/dist/py/path/svn/wccommand.py
Log:
add missing docstrings to open. add a list of all missing docstrings to the
TODO file.


Modified: py/dist/py/documentation/TODO.txt
==============================================================================
--- py/dist/py/documentation/TODO.txt	(original)
+++ py/dist/py/documentation/TODO.txt	Tue Jan  9 12:40:11 2007
@@ -77,3 +77,112 @@
   using Armin's collect class 
 
 * hide py.test.TerminalSession and TkinterSession?  (questionable) 
+
+
+Missing docstrings
+------------------
+
+_thread.WorkerPool misses a docstring
+_thread.WorkerPool.shutdown misses a docstring
+_thread.WorkerPool.join misses a docstring
+_thread.WorkerPool.__init__ misses a docstring
+_thread.ThreadOut misses a docstring
+_thread.ThreadOut.write misses a docstring
+_thread.ThreadOut.setwritefunc misses a docstring
+_thread.ThreadOut.setdefaultwriter misses a docstring
+_thread.ThreadOut.resetdefault misses a docstring
+_thread.NamedThreadPool misses a docstring
+code.Traceback misses a docstring
+code.Traceback.Entry misses a docstring
+code.Source.getblockend misses a docstring
+code.Code misses a docstring
+execnet.SshGateway misses a docstring
+execnet.SocketGateway misses a docstring
+execnet.PopenGateway misses a docstring
+initpkg misses a docstring
+io.dupfile misses a docstring
+log.setconsumer misses a docstring
+log.get misses a docstring
+log.Syslog misses a docstring
+log.STDOUT misses a docstring
+log.STDERR misses a docstring
+log.Producer.Message misses a docstring
+log.Path misses a docstring
+magic.greenlet misses a docstring
+magic.greenlet.getcurrent misses a docstring
+magic.greenlet.error misses a docstring
+magic.greenlet.GreenletExit misses a docstring
+magic.View.__viewkey__ misses a docstring
+magic.View.__repr__ misses a docstring
+magic.View.__new__ misses a docstring
+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.readlines 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.move 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
+path.svnwc.__new__ misses a docstring
+path.svnwc.__iter__ misses a docstring
+path.svnwc.__hash__ misses a docstring
+path.svnwc.__eq__ misses a docstring
+path.svnwc.Checkers misses a docstring
+path.svnurl misses a docstring
+path.svnurl.__new__ misses a docstring
+path.svnurl.Checkers misses a docstring
+path.local.visit misses a docstring
+path.local.sysexec has an 'XXX' in its docstring
+path.local.Checkers misses a docstring
+path.extpy.__new__ misses a docstring
+path.extpy.Checkers misses a docstring
+test.rest.RestReporter misses a docstring
+test.rest.RelLinkWriter misses a docstring
+test.rest.NoLinkWriter misses a docstring
+test.rest.LinkWriter misses a docstring
+test.exit misses a docstring
+test.deprecated_call misses a docstring
+test.collect.Module misses a docstring
+test.collect.Module.Skipped misses a docstring
+test.collect.Module.Passed misses a docstring
+test.collect.Module.Outcome misses a docstring
+test.collect.Module.Failed misses a docstring
+test.collect.Module.ExceptionFailure misses a docstring
+test.collect.Instance misses a docstring
+test.collect.Generator misses a docstring
+test.collect.DoctestFile misses a docstring
+test.collect.Directory misses a docstring
+test.collect.Collector misses a docstring
+test.collect.Class misses a docstring
+test.cmdline.main misses a docstring
+test.TkinterSession misses a docstring
+test.TerminalSession misses a docstring
+test.RSession.reporterror misses a docstring
+test.RSession.make_colitems misses a docstring
+test.RSession.getpkgdir misses a docstring
+test.Item misses a docstring
+xml.html misses a docstring
+xml.html.__tagclass__ misses a docstring
+xml.html.__tagclass__.Attr misses a docstring
+xml.html.__metaclass__ misses a docstring
+xml.html.Style misses a docstring
+xml.escape misses a docstring
+xml.Tag 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 12:40:11 2007
@@ -70,6 +70,7 @@
         return self._escape(self.strpath)
 
     def open(self, mode='r'):
+        """ return an opened file with the given mode. """
         assert 'w' not in mode and 'a' not in mode, "XXX not implemented for svn cmdline"
         assert self.check(file=1) # svn cat returns an empty file otherwise
         def popen(cmd):

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 12:40:11 2007
@@ -430,6 +430,7 @@
         return paths
 
     def open(self, mode='r'):
+        """ return an opened file with the given mode. """
         return open(self.strpath, mode)
 
     def _getbyspec(self, spec):