Skip to content

Commit fc01633

Browse files
authored
Fix documentation about the default timeout for runTest (Kotlin#4099)
The default timeout for runTest changed from 10 seconds to 60 seconds in 9a98eab.
1 parent aa72711 commit fc01633

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

kotlinx-coroutines-test/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ on Kotlin/JS. The main differences are the following:
107107

108108
* **The calls to `delay` are automatically skipped**, preserving the relative execution order of the tasks. This way,
109109
it's possible to make tests finish more-or-less immediately.
110-
* **The execution times out after 10 seconds**, cancelling the test coroutine to prevent tests from hanging forever
110+
* **The execution times out after 60 seconds**, cancelling the test coroutine to prevent tests from hanging forever
111111
and eating up the CI resources.
112112
* **Controlling the virtual time**: in case just skipping delays is not sufficient, it's possible to more carefully
113113
guide the execution, advancing the virtual time by a duration, draining the queue of the awaiting tasks, or running
@@ -119,7 +119,7 @@ on Kotlin/JS. The main differences are the following:
119119

120120
## Timeout
121121

122-
Test automatically time out after 10 seconds. For example, this test will fail with a timeout exception:
122+
Test automatically time out after 60 seconds. For example, this test will fail with a timeout exception:
123123

124124
```kotlin
125125
@Test
@@ -128,7 +128,7 @@ fun testHanging() = runTest {
128128
}
129129
```
130130

131-
In case the test is expected to take longer than 10 seconds, the timeout can be increased by passing the `timeout`
131+
In case the test is expected to take longer than 60 seconds, the timeout can be increased by passing the `timeout`
132132
parameter:
133133

134134
```kotlin

0 commit comments

Comments
 (0)