Update documentation on block_in_place #3753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Darksonn
added
T-docs
carllerche
reviewed
May 5, 2021
tokio/src/task/blocking.rs
Outdated
| @@ -6,18 +6,23 @@ cfg_rt_multi_thread! { | |||
| /// | |||
| /// In general, issuing a blocking call or performing a lot of compute in a | |||
| /// future without yielding is not okay, as it may prevent the executor from | |||
There was a problem hiding this comment.
unrelated, but "is not okay" probably can be reworded to: "is problematic"
carllerche
reviewed
May 5, 2021
tokio/src/task/blocking.rs
Outdated
| /// instead. | ||
| /// | ||
| /// Note that this function can only be used when using the `multi_thread` runtime. | ||
| /// driving other tasks forward. By using this function, the executor |
There was a problem hiding this comment.
"Calling this function informs the executor that the currently executing task is about to block the thread"
maybe? TOLI
carllerche
approved these changes
May 5, 2021
This was referenced May 10, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation on
block_in_placeto fix some things that were unclear. There is already a PR that tries to address this, but I have found that the documentation needed a larger change.Closes: #3659, #3658