kotlinx.coroutines
kotlinx.coroutines copied to clipboard
Document structured concurrency
trafficstars
Draft for now, because the documentation of some other functions should be updated accordingly:
- [x] The remaining entries in
CoroutineScope.kt. - [x]
supervisorScope - [x]
Builders.common.kt:launch,async, and the other coroutine builders should document their structured concurrency behaviors. - [ ] The
withTimeoutfamily of functions. - [ ]
produce. - [ ] Coroutine builders from the reactive integrations.
- [ ] JS+Wasm
promise. - [ ] The
futurefunction.
but reviewing the changes should already be okay (I'll introduce further changes in separate commits).
cc @LouisCAD, given your real-world experience and interest in the documentation, your comments on this would be greatly appreciated!