Add retries documentation (#200)

* Add retries documentation * lint * lint * Update README.md Co-authored-by: Ben Tranter <[email protected]> --------- Co-authored-by: Ben Tranter <[email protected]>
digitalocean · Sep 26, 2023 · 693af8c · 693af8c
1 parent c9ad85d
commit 693af8c
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -89,6 +89,21 @@ else:
     paginated = False
 ```
 
+#### Retries and Backoff
+
+By default the client uses the same retry policy as the [Azure SDK for Python](https://learn.microsoft.com/en-us/python/api/azure-core/azure.core.pipeline.policies.retrypolicy?view=azure-python).
+retry policy. If you'd like to modify any of these values, you can pass them as keywords to your client initialization:
+
+```python
+client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN"), retry_total=3)
+```
+
+or
+
+```python
+client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN"), retry_policy=MyRetryPolicy())
+```
+
 # **Contributing**
 
 >Visit our [Contribuing Guide](CONTRIBUTING.md) for more information on getting