Skip to content

Commit 468d909

Browse files
committed
Fix AsyncOperations docs
1 parent bfb4f10 commit 468d909

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
@@ -2,19 +2,24 @@ package gears.async
22

33
import scala.concurrent.duration.FiniteDuration
44

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

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

17-
/** Suspends the current [[Async]] context for at least [[millis]] milliseconds.
22+
/** Suspends the current [[Async]] context for `duration`.
1823
* @param duration
1924
* The duration to suspend. Must be positive.
2025
*/

0 commit comments

Comments
 (0)