doc tweak

This commit is contained in:
dtookey 2023-08-06 21:03:19 -04:00
parent 30505d5b21
commit b8ac295330

View File

@ -75,9 +75,8 @@ interface TemporalController {
/**
* Sleeps for the specified duration with some variance.
*
* This will sleep for the given duration plus or minus a random variance.
* The variance is divided in half to generate a random positive and negative
* value that is added to the duration.
* This will sleep for the given duration plus a random variance between 0 inclusive and [variance] exclusive.
* The variance is divided in half to generate a random positive value that is added to the duration.
*
* If the duration is negative or the variance is less than 1, this method
* will return immediately without sleeping.