From 93af278d6170cb38eeb189fe8deb957b98d20876 Mon Sep 17 00:00:00 2001
From: Christopher Rosell <chrippa@tanuki.se>
Date: Fri, 24 Aug 2012 02:28:42 +0200
Subject: Add some docs.

---
 src/livestreamer/stream.py | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'src/livestreamer/stream.py')

diff --git a/src/livestreamer/stream.py b/src/livestreamer/stream.py
index 398bb6f..e71e3bc 100644
--- a/src/livestreamer/stream.py
+++ b/src/livestreamer/stream.py
@@ -10,11 +10,21 @@ class StreamError(Exception):
     pass
 
 class Stream(object):
+    """
+        This is a base class that should be inherited when implementing
+        different stream types. Should only be used directly from plugins.
+    """
+
     def __init__(self, session):
         self.session = session
 
     def open(self):
-       raise NotImplementedError
+        """
+            Opens a connection to the stream.
+            Returns a file-like object than can be used to read data.
+            Raises :exc:`StreamError` on failure.
+        """
+        raise NotImplementedError
 
 class StreamProcess(Stream):
     def __init__(self, session, params={}):
-- 
cgit v1.2.3