[py-svn] r37815 - py/trunk/py/doc

[hpk at codespeak.net]

Author: hpk
Date: Fri Feb  2 19:27:22 2007
New Revision: 37815

Modified:
   py/trunk/py/doc/TODO.txt
   py/trunk/py/doc/path.txt
Log:
path.txt: showing a bit more for string methods
update TODO


Modified: py/trunk/py/doc/TODO.txt
==============================================================================
--- py/trunk/py/doc/TODO.txt	(original)
+++ py/trunk/py/doc/TODO.txt	Fri Feb  2 19:27:22 2007
@@ -37,10 +37,7 @@
 * make "_" namespace:  
   py.log -> py._log (pypy!) 
 
-* review py.io and write py.io.dupfile docstring
-
-  (guido - added docstring, and code looks okay (what was the reason for the
-  review? anything specific?)
+* (done mostly) review py.io and write py.io.dupfile docstring
 
 * re-consider what to do with read and write methods of py.path classes (since
   there are places that check for file-ness by doing hasattr(... 'write'))

Modified: py/trunk/py/doc/path.txt
==============================================================================
--- py/trunk/py/doc/path.txt	(original)
+++ py/trunk/py/doc/path.txt	Fri Feb  2 19:27:22 2007
@@ -108,17 +108,18 @@
   >>> subdir.join('textfile2.txt').write('spam eggs spam foo bar spam')
   >>> results = []
   >>> for fpath in dirpath.visit('*.txt'):
-  ...   if 'bar' in fpath.read():
-  ...     results.append(fpath.basename)
+  ...     if 'bar' in fpath.read():
+  ...         results.append(fpath.basename)
   >>> results
   ['textfile1.txt', 'textfile2.txt', 'textfile2.txt']
 
-Joining path types 
+Working with Paths 
 ++++++++++++++++++++
 
-This example shows the :api:`py.path` features to deal with actual paths
-(strings). Note that the filesystem is never touched, all operations are
-performed on a string level (so the paths don't have to exist, either)::
+This example shows the :api:`py.path` features to deal with
+filesystem paths Note that the filesystem is never touched,
+all operations are performed on a string level (so the paths
+don't have to exist, either)::
 
   >>> p1 = py.path.local('/foo/bar')
   >>> p2 = p1.join('baz/qux')
@@ -130,6 +131,13 @@
   >>> p3 = p1 / 'baz/qux' # the / operator allows joining, too
   >>> p2 == p3
   True
+  >>> p4 = p1 + ".py"  
+  >>> p4.basename == "bar.py"
+  True
+  >>> p4.ext == ".py"
+  True
+  >>> p4.purebasename == "bar"
+  True
 
 This should be possible on every implementation of :api:`py.path`, so
 regardless of whether the implementation wraps a UNIX filesystem, a Windows