Improves retry middleware documentation. (#1228)

lostisland · Dec 31, 2020 · 453b26f · 453b26f
1 parent 687108b
commit 453b26f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/middleware/request/retry.md b/docs/middleware/request/retry.md
@@ -110,7 +110,7 @@ retry_options = {
 
 ### Call a block on every retry
 
-You can specify a block through the `retry_block` option that will be called every time the request is retried.
+You can specify a block through the `retry_block` option that will be called before every retry.
 There are many different applications for this feature, spacing from instrumentation to monitoring.
 Request environment, middleware options, current number of retries and the exception is passed to the block as parameters.
 For example, you might want to keep track of the response statuses:

diff --git a/lib/faraday/request/retry.rb b/lib/faraday/request/retry.rb
@@ -112,7 +112,7 @@ def retry_statuses
       #   not independent of the retry count. This would be useful
       #   if the exception produced is non-recoverable or if the
       #   the HTTP method called is not idempotent.
-      # @option options [Block] :retry_block block that is executed after
+      # @option options [Block] :retry_block block that is executed before
       #   every retry. Request environment, middleware options, current number
       #   of retries and the exception is passed to the block as parameters.
       # @option options [Array] :retry_statuses Array of Integer HTTP status