Added note and client construction example that's configured with Replay429Adapter

emlaver · emlaver · commit adb2dfff56c7 · 2017-01-05T11:37:17.000-05:00
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -23,6 +23,10 @@ then disconnecting from the server.
 Later in the `Context managers`_ section we will see how to 
 simplify this process through the use of the Python *with* statement.
 
+Note: If you require retrying requests after an HTTP 429 error, the
+``Replay429Adapter`` can be added when constructing a ``Cloudant``
+client and configured with an initial back off and retry count.
+
 Connecting with a client
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -38,6 +42,10 @@ Connecting with a client
     # or using url
     # client = Cloudant(USERNAME, PASSWORD, url='https://acct.cloudant.com')
 
+    # or with a 429 replay adapter that includes configured retries and initial backoff
+    # client = Cloudant(USERNAME, PASSWORD, account=ACCOUNT_NAME,
+    #                   adapter=Replay429Adapter(retries=10, initialBackoff=0.01))
+
     # Perform client tasks...
     session = client.session()
     print 'Username: {0}'.format(session['userCtx']['name'])
