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

Improve the yield() documentation #4260

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Improve the yield() documentation #4260

merged 1 commit into from
Oct 25, 2024

Conversation

dkhalanskyjb
Copy link
Collaborator

No description provided.

@dkhalanskyjb dkhalanskyjb requested a review from qwwdfsad October 25, 2024 10:19
@dkhalanskyjb dkhalanskyjb merged commit f39e482 into develop Oct 25, 2024
1 check passed
@dkhalanskyjb dkhalanskyjb deleted the dk-yield-doc branch October 25, 2024 12:00
*
* A coroutine run uninterrupted on a thread until the coroutine *suspend*,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* A coroutine run uninterrupted on a thread until the coroutine *suspend*,
* A coroutine runs uninterrupted on a thread until the coroutine *suspends*,

* Calling [yield] has this effect:
*
* ```
* fun updateProgressBar(value: Int, marker: String) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the value parameter necessary for this example? Removing the parameter (and not passing it) seems simpler and allows you to focus on the behavior that this example is intended to illustrate.

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

Successfully merging this pull request may close these issues.

3 participants