From 2fd2de61fd774d5d7bbc8d205e98235a4fa60cfe Mon Sep 17 00:00:00 2001
From: Robert Collins <robertc@robertcollins.net>
Date: Sun, 11 Oct 2009 07:26:52 +1100
Subject: More docs.

---
 python/subunit/__init__.py | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'python')

diff --git a/python/subunit/__init__.py b/python/subunit/__init__.py
index 38ec9b8..a833159 100644
--- a/python/subunit/__init__.py
+++ b/python/subunit/__init__.py
@@ -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()
-- 
cgit v1.2.1