[Zodb-checkins] CVS: ZODB3/ZEO - ClientStub.py:1.10

[Guido van Rossum]

Update of /cvs-repository/ZODB3/ZEO
In directory cvs.zope.org:/tmp/cvs-serv29247

Modified Files:
	ClientStub.py 
Log Message:
Add a docstring to __init__ and add a pointer to the docs for the
methods here.


=== ZODB3/ZEO/ClientStub.py 1.9 => 1.10 ===
--- ZODB3/ZEO/ClientStub.py:1.9	Tue Oct  1 14:36:09 2002
+++ ZODB3/ZEO/ClientStub.py	Tue Oct  1 14:38:22 2002
@@ -21,6 +21,8 @@
     StorageServer; i.e. the StorageServer calls these methods and they
     are executed in the ClientStorage.
 
+    See the ClientStorage class for documentation on these methods.
+
     It is currently important that all methods here are asynchronous
     (meaning they don't have a return value and the caller doesn't
     wait for them to complete), *and* that none of them cause any
@@ -31,10 +33,14 @@
     Python method names.  That's because the on-the-wire protocol was
     fixed for ZEO 2 and we don't want to change it.  There are some
     aliases in ClientStorage.py to make up for this.
-
     """
 
     def __init__(self, rpc):
+        """Constructor.
+
+        The argument is a connection: an instance of the
+        zrpc.connection.Connection class.
+        """
         self.rpc = rpc
 
     def beginVerify(self):