Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Invalid documentation for kotlin-coroutines-test TestCoroutineDispatcher #1163

Closed
szymonkozak opened this issue Apr 30, 2019 · 1 comment
Closed
Assignees
Labels

Comments

@szymonkozak
Copy link

szymonkozak commented Apr 30, 2019

In documentation example for kotlin-coroutines-test about TestCoroutineDispatcher there is testScope property which doesn't exist.

https://github.com/Kotlin/kotlinx.coroutines/blame/master/kotlinx-coroutines-test/README.md#L343

Also, in text

Since TestCoroutineDispatcher is stateful in order to keep track of executing coroutines, it is important to ensure that cleanupTestCoroutines is called after every test case.

link to cleanupTestCoroutines function is invalid. (https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-test/kotlinx.coroutines.test/-test-coroutine-dispatcher/cleanup-test-coroutines.html)

@elizarov
Copy link
Contributor

Good catch. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants