summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2009-10-11 07:26:52 +1100
committerRobert Collins <robertc@robertcollins.net>2009-10-11 07:26:52 +1100
commit2fd2de61fd774d5d7bbc8d205e98235a4fa60cfe (patch)
tree23704503b3d20f547193e51c32d6c12041a08ed0 /python
parent6bd5e4bca85e29d01ed108d4b9709e840aa1ba8f (diff)
downloadsubunit-git-2fd2de61fd774d5d7bbc8d205e98235a4fa60cfe.tar.gz
More docs.
Diffstat (limited to 'python')
-rw-r--r--python/subunit/__init__.py5
1 files changed, 5 insertions, 0 deletions
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()