X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/741507400802fcda26c684a650cc66375fa4906e..6990ead71ac6484c64013bf731338a757ab3230f:/twitter/stream.py diff --git a/twitter/stream.py b/twitter/stream.py index 2fd9cd8..e60157c 100644 --- 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,7 @@ class TwitterStream(TwitterStreamCall): The iterator will yield tweets forever and ever (until the stream breaks at which point it raises a TwitterHTTPError.) - The `block` paramater controls if the stream is blocking. Default + 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. """