Skip to content

Commit 5bf5400

Browse files
committed
Fix AsyncOperations docs
1 parent ff9cb51 commit 5bf5400

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

shared/src/main/scala/async/AsyncOperations.scala

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,24 @@ import scala.concurrent.duration.FiniteDuration
44
import java.util.concurrent.TimeoutException
55
import gears.async.AsyncOperations.sleep
66

7+
/** Defines fundamental operations that require the support of the scheduler. This is commonly provided alongside with
8+
* the given implementation of [[Scheduler]].
9+
* @see
10+
* [[Scheduler]] for the definition of the scheduler itself.
11+
*/
712
trait AsyncOperations:
8-
/** Suspends the current [[Async]] context for at least [[millis]] milliseconds. */
13+
/** Suspends the current [[Async]] context for at least `millis` milliseconds. */
914
def sleep(millis: Long)(using Async): Unit
1015

1116
object AsyncOperations:
12-
/** Suspends the current [[Async]] context for at least [[millis]] milliseconds.
17+
/** Suspends the current [[Async]] context for at least `millis` milliseconds.
1318
* @param millis
14-
* The duration to suspend. Must be a positive integer.
19+
* The duration to suspend, in milliseconds. Must be a positive integer.
1520
*/
1621
inline def sleep(millis: Long)(using AsyncOperations, Async): Unit =
1722
summon[AsyncOperations].sleep(millis)
1823

19-
/** Suspends the current [[Async]] context for at least [[millis]] milliseconds.
24+
/** Suspends the current [[Async]] context for `duration`.
2025
* @param duration
2126
* The duration to suspend. Must be positive.
2227
*/

0 commit comments

Comments
 (0)