Skip to content

yield function doc #2464

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

Closed
cy6erGn0m opened this issue Dec 29, 2020 · 0 comments
Closed

yield function doc #2464

cy6erGn0m opened this issue Dec 29, 2020 · 0 comments
Labels
docs KDoc and API reference

Comments

@cy6erGn0m
Copy link
Contributor

The yield function doc states at the first line:

Yields the thread (or thread pool) of the current coroutine dispatcher to other coroutines to run if possible.

The problem is that it makes an impression that it's applied globally regardless of the current dispatcher. In spite of the last sentence points to the dispatcher-sensitivity, people get confused anyway.

We need to clarify it so people see that the yield function only affects coroutines running on the same dispatcher.

@cy6erGn0m cy6erGn0m added the docs KDoc and API reference label Dec 29, 2020
qwwdfsad added a commit that referenced this issue Dec 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs KDoc and API reference
Projects
None yet
Development

No branches or pull requests

1 participant