[Zope-Checkins] CVS: StandaloneZODB/ZODB/tests - HistoryStorage.py:1.5 IteratorStorage.py:1.4 StorageTestBase.py:1.7 TransactionalUndoStorage.py:1.13

[Jeremy Hylton]

Update of /cvs-repository/StandaloneZODB/ZODB/tests
In directory cvs.zope.org:/tmp/cvs-serv13960/ZODB/tests

Modified Files:
	HistoryStorage.py IteratorStorage.py StorageTestBase.py 
	TransactionalUndoStorage.py 
Log Message:
doc strings



=== StandaloneZODB/ZODB/tests/HistoryStorage.py 1.4 => 1.5 ===
-# the history() method should be able to pass all these tests.
+"""Run the history() related tests for a storage.
+
+Any storage that supports the history() method should be able to pass
+all these tests.
+"""
 
 from ZODB.tests.MinPO import MinPO
 from ZODB.tests.StorageTestBase import zodb_unpickle


=== StandaloneZODB/ZODB/tests/IteratorStorage.py 1.3 => 1.4 ===
-# supports the iterator() method should be able to pass all these tests.
+"""Run tests against the iterator() interface for storages.
+
+Any storage that supports the iterator() method should be able to pass
+all these tests.
+"""
 
 from ZODB.tests.MinPO import MinPO
 from ZODB.tests.StorageTestBase import zodb_unpickle


=== StandaloneZODB/ZODB/tests/StorageTestBase.py 1.6 => 1.7 ===
-# provides basic setUp() and tearDown() semantics (which you can override),
-# and it also provides a helper method _dostore() which performs a complete
-# store transaction for a single object revision.
+"""Provide a mixin base class for storage tests.
+
+The StorageTestBase class provides basic setUp() and tearDown()
+semantics (which you can override), and it also provides a helper
+method _dostore() which performs a complete store transaction for a
+single object revision.
+"""
 
 import pickle
 import string
@@ -18,6 +21,7 @@
 ZERO = '\0'*8
 
 def zodb_pickle(obj):
+    """Create a pickle in the format expected by ZODB."""
     f = StringIO()
     p = Pickler(f, 1)
     klass = obj.__class__
@@ -35,6 +39,7 @@
     return f.getvalue(1)
 
 def zodb_unpickle(data):
+    """Unpickle an object stored using the format expected by ZODB."""
     f = StringIO(data)
     u = Unpickler(f)
     klass_info = u.load()


=== StandaloneZODB/ZODB/tests/TransactionalUndoStorage.py 1.12 => 1.13 ===
-# must pass these tests.
+"""Check transactionalUndo().
+
+Any storage that supports transactionalUndo() must pass these tests.
+"""
 
 import types
 from ZODB import POSException