From b8ac295330c0175b3a672e6a11b8e4c6190ddc93 Mon Sep 17 00:00:00 2001 From: dtookey Date: Sun, 6 Aug 2023 21:03:19 -0400 Subject: [PATCH] doc tweak --- src/main/kotlin/Controllers.kt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/main/kotlin/Controllers.kt b/src/main/kotlin/Controllers.kt index 47bba77..a239af3 100644 --- a/src/main/kotlin/Controllers.kt +++ b/src/main/kotlin/Controllers.kt @@ -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.