More docs.
authorRobert Collins <robertc@robertcollins.net>
Sat, 10 Oct 2009 20:26:52 +0000 (07:26 +1100)
committerRobert Collins <robertc@robertcollins.net>
Sat, 10 Oct 2009 20:26:52 +0000 (07:26 +1100)
python/subunit/__init__.py

index 38ec9b897e0fade07504276fd119e61e834757b2..a8331595819c03bc3648d17bf822df25260efd94 100644 (file)
@@ -511,6 +511,11 @@ class TestProtocolServer(object):
         self._state.lostConnection()
 
     def readFrom(self, pipe):
+        """Blocking convenience API to parse an entire stream.
+        
+        :param pipe: A file-like object supporting readlines().
+        :return: None.
+        """
         for line in pipe.readlines():
             self.lineReceived(line)
         self.lostConnection()