make inversion optional

[z_archive/twitter.git] / twitter / stream.py

diff --git a/twitter/stream.py b/twitter/stream.py
index 1ee90988da63a2dd55caa269813faa7f76e500d7..e60157c43a57b03cb9a773af026d7fdf1fabe4a7 100644 (file)
--- a/twitter/stream.py
+++ b/twitter/stream.py
@@ -60,10 +60,11 @@ class TwitterStreamCallNonBlocking(TwitterCall):
 
 class TwitterStream(TwitterStreamCall):
     """
-    Interface to the Twitter Stream API (stream.twitter.com). This can
-    be used pretty much the same as the Twitter class except the
-    result of calling a method will be an iterator that yields objects
-    decoded from the stream. For example::
+    The TwitterStream object is an interface to the Twitter Stream API
+    (stream.twitter.com). This can be used pretty much the same as the
+    Twitter class except the result of calling a method will be an
+    iterator that yields objects decoded from the stream. For
+    example::
 
         twitter_stream = TwitterStream(auth=UserPassAuth('joe', 'joespassword'))
         iterator = twitter_stream.statuses.sample()
@@ -74,7 +75,9 @@ class TwitterStream(TwitterStreamCall):
     The iterator will yield tweets forever and ever (until the stream
     breaks at which point it raises a TwitterHTTPError.)
 
-    The `bloc` paramater controls if the stream is blocking. 
+    The `block` parameter controls if the stream is blocking. Default
+    is blocking (True). When set to False, the iterator will
+    occasionally yield None when there is no available message.
     """
     def __init__(
         self, domain="stream.twitter.com", secure=True, auth=None,