Commits

dan mackinlay committed 019df8b

docs updates

Comments (0)

Files changed (2)

+=========
 FSDict
 =========
 
-Dictionary access to a filesystem, for serializing things that are too large to be pickled together, or even shelved, or that you with to version control more cleanly than shelve will allow.
+Dictionary access to a filesystem, for serializing things that are too large
+to be pickled together, or even shelved, or that you with to version control
+more cleanly than shelve will allow.
 
-Since googling this project name, I've found `a cleaner implementation <http://blog.ianbicking.org/2007/08/17/dictmixin/>`_ by Ian Bicking that I should probably base my own small innovations on.
+Since googling this project name, I've found `a cleaner implementation
+<http://blog.ianbicking.org/2007/08/17/dictmixin/>`_ by Ian Bicking that I
+should probably base my own small innovations on.
+
+TODO
+=====
+
+* tests for recursive copying
+* better docs
+* tests for parent class
 
 class FSPickleDict(FSDict):
     """
-    provide dictionary access to a temp dir, storing any picklable object.
+    Provide dictionary access to a temp dir, storing any picklable object. Not
+    that this is not completely symmtrical with FSDict - *that* will store
+    *only* strings in values, but this will store *anything but* FSDicts in
+    values
     """
     def __setitem__(self, item, value):
         if item in self: