changeset 730:1e9b0d1ad897

Moved documentation of ShareExchanger.incoming_data.
author Martin Geisler <mg@daimi.au.dk>
date Thu, 24 Apr 2008 14:45:39 +0200
parents cade54734d47
children e5c8d22434d4
files doc/runtime.txt viff/runtime.py
diffstat 2 files changed, 7 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/doc/runtime.txt	Thu Apr 24 14:40:09 2008 +0200
+++ b/doc/runtime.txt	Thu Apr 24 14:45:39 2008 +0200
@@ -14,6 +14,13 @@
    .. autoclass:: viff.runtime.ShareExchanger
       :members: sendShare, sendData, loseConnection
 
+      .. attribute:: ShareExchanger.incoming_data
+
+         Data from our peer is put here, either as an empty
+         :class:`Deferred` if we are waiting on input from the player,
+         or the data itself if data is received from the other player
+         before we are ready to use it.
+
    .. autofunction:: viff.runtime.increment_pc
 
    .. autofunction:: viff.runtime.create_runtime
--- a/viff/runtime.py	Thu Apr 24 14:40:09 2008 +0200
+++ b/viff/runtime.py	Thu Apr 24 14:45:39 2008 +0200
@@ -254,11 +254,6 @@
         self.peer_id = None
 
         #: Data expected to be received in the future.
-        #:
-        #: Data from our peer is put here, either as an empty Deferred
-        #: if we are waiting on input from the player, or the data
-        #: itself if data is received from the other player before we
-        #: are ready to use it.
         self.incoming_data = {}
 
     def connectionMade(self):