Skip to content

Commit

Permalink
finagle-core: Remove incorrect explanation of ResponseClassifier in docs
Browse files Browse the repository at this point in the history
Problem:

Documentation for RetryPolicy incorrectly states that a request will be retried
if a custom response classifier is provided. The ResponseClassifier only checks
whether or not to make a deposit to the retryBudget. It is not possible to tell
Finagle which application-level exceptions are retryable in the RequeueFilter.

Solution:

Remove this sentence.

JIRA Issues: CSL-10125

Differential Revision: https://phabricator.twitter.biz/D575036
  • Loading branch information
tigerlily-he authored and jenkins committed Nov 6, 2020
1 parent b439578 commit 0c7890c
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import scala.collection.JavaConverters._
* a [[Duration]] field for how long to wait for the next retry as well
* as the next `RetryPolicy` to use.
*
* Finagle will handle retryable Throws automatically but you will need to
* supply a custom [[ResponseClassifier]] to inform Finagle which application
* level exceptions are retryable.
* Finagle will automatically handle retryable Throws. Requests that
* have not been written to or processed by a remote service are safe to
* retry.
*
* @see [[SimpleRetryPolicy]] for a Java friendly API.
*/
Expand Down

0 comments on commit 0c7890c

Please sign in to comment.