From cf702200ee04f9377aecd7be7472517a23afd2d2 Mon Sep 17 00:00:00 2001 From: Oxan van Leeuwen Date: Fri, 8 Nov 2024 17:13:33 +0100 Subject: [PATCH] Document units for ExponentialBackOffStrategy parameters "ms" is commonly understood to be milliseconds, but is used for microseconds (commonly denoted as us) here. Add a docblock to make it clear that this deviates from the convention. --- src/ExponentialBackOffStrategy.php | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/ExponentialBackOffStrategy.php b/src/ExponentialBackOffStrategy.php index c7652f3..0950054 100644 --- a/src/ExponentialBackOffStrategy.php +++ b/src/ExponentialBackOffStrategy.php @@ -22,6 +22,10 @@ class ExponentialBackOffStrategy implements BackOffStrategy private $sleeper; private Jitter $jitter; + /** + * @param $initialDelayMs Initial delay, in MICROseconds. + * @param $maxDelay Maximum delay, in microseconds. + */ public function __construct( int $initialDelayMs, int $maxTries,