kotlinx.coroutines icon indicating copy to clipboard operation
kotlinx.coroutines copied to clipboard

Document structured concurrency

Open dkhalanskyjb opened this issue 6 months ago • 0 comments
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 withTimeout family of functions.
  • [ ] produce.
  • [ ] Coroutine builders from the reactive integrations.
  • [ ] JS+Wasm promise.
  • [ ] The future function.

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!

dkhalanskyjb avatar May 09 '25 12:05 dkhalanskyjb