Skip to content

Commit 6f76666

Browse files
committed
Clarify documentation for Curl::setRetry() and MultiCurl::setRetry()
1 parent 12661cf commit 6f76666

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

src/Curl/Curl.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,8 +1136,13 @@ public function setReferrer($referrer)
11361136
/**
11371137
* Set Retry
11381138
*
1139-
* Number of retries to attempt or decider callable. Maximum number of
1140-
* attempts is $maximum_number_of_retries + 1.
1139+
* Number of retries to attempt or decider callable.
1140+
*
1141+
* When using a number of retries to attempt, the maximum number of attempts
1142+
* for the request is $maximum_number_of_retries + 1.
1143+
*
1144+
* When using a callable decider, the request will be retried until the
1145+
* function returns a value which evaluates to false.
11411146
*
11421147
* @access public
11431148
* @param $mixed

src/Curl/MultiCurl.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -672,8 +672,13 @@ public function setReferrer($referrer)
672672
/**
673673
* Set Retry
674674
*
675-
* Number of retries to attempt or decider callable. Maximum number of
676-
* attempts is $maximum_number_of_retries + 1.
675+
* Number of retries to attempt or decider callable.
676+
*
677+
* When using a number of retries to attempt, the maximum number of attempts
678+
* for the request is $maximum_number_of_retries + 1.
679+
*
680+
* When using a callable decider, the request will be retried until the
681+
* function returns a value which evaluates to false.
677682
*
678683
* @access public
679684
* @param $mixed

0 commit comments

Comments
 (0)