Updating documentation about :max_retries to include information abou…

…t throttling errors.
aws · Nov 8, 2013 · b1844f9 · b1844f9
1 parent 5faa4b9
commit b1844f9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/lib/aws/core.rb b/lib/aws/core.rb
@@ -368,8 +368,8 @@ class << self
     #   and instance of {Core::Response} and returns a string.
     #
     # @option options [Integer] :max_retries (3) The maximum number of times
-    #   service errors (500) should be retried.  There is an exponential
-    #   backoff in between service request retries, so the more retries the
+    #   service errors (500) and throttling errors should be retried. There is
+    #   an exponential backoff in between retries, so the more retries the
     #   longer it can take to fail.
     #
     # @option options [String, URI, nil] :proxy_uri (nil) The URI of the proxy

diff --git a/lib/aws/core/configuration.rb b/lib/aws/core/configuration.rb
@@ -121,8 +121,8 @@ module Core
     # @attr_reader [LogFormatter] log_formatter The log message formatter.
     #
     # @attr_reader [Integer] max_retries (3) The maximum number of times
-    #   service errors (500) should be retried.  There is an exponential
-    #   backoff in between service request retries, so the more retries the
+    #   service errors (500) and throttling errors should be retried. There is
+    #   an exponential backoff in between retries, so the more retries the
     #   longer it can take to fail.
     #
     # @attr_reader [URI,nil] proxy_uri (nil) The URI of the proxy