Update API constructor documentation
authorAaron Hill <aa1ronham@gmail.com>
Tue, 29 Apr 2014 22:05:58 +0000 (18:05 -0400)
committerAaron Hill <aa1ronham@gmail.com>
Tue, 29 Apr 2014 22:05:58 +0000 (18:05 -0400)
docs/api.rst

index 0dab297b54c9b24249147aec93f25c1fa39a890f..0b5031b5ab30e21ce2bb430e6f3479ffa087b39e 100644 (file)
@@ -25,7 +25,12 @@ This page contains some basic documentation for the Tweepy module.
    :param retry_count: default number of retries to attempt when error occurs
    :param retry_delay: number of seconds to wait between retries
    :param retry_errors: which HTTP status codes to retry
-   :param model_factory: used for creating new model instances
+   :param timeout: The maximum amount of time to wait for a response from Twitter
+   :param parser: The object to use for parsing the response from Twitter
+   :param compression: Whether or not to use GZIP compression for requests
+   :param wait_on_rate_limit: Whether or not to automatically wait for rate limits to replenish
+   :param wait_on_rate_limit_notify: Whether or not to print a notification when Tweepy is waiting for rate limits to replenish
+   :param proxy: The full url to an HTTPS proxy to use for connecting to Twitter.
 
 Timeline methods
 ----------------