Document implicit yield in install() per #1105 #1107
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
cuviper
reviewed
Nov 30, 2023
rayon-core/src/thread_pool/mod.rs
Outdated
Comment on lines
85
to
87
| /// `install()` implicitly calls [`ThreadPool::yield_now()`], | ||
| /// potentially scheduling another task to run on the current thread. For | ||
| /// example: |
There was a problem hiding this comment.
I would like this to clarify the context a bit more, something like:
Suggested change
| /// `install()` implicitly calls [`ThreadPool::yield_now()`], | |
| /// potentially scheduling another task to run on the current thread. For | |
| /// example: | |
| /// If the current thread is part of a different thread pool, it will try to | |
| /// keep busy while the `op` completes in its target pool, similar to | |
| /// calling [`ThreadPool::yield_now()`] in a loop. Therefore, it may | |
| /// potentially schedule other tasks to run on the current thread in the | |
| /// meantime. For example: |
Does that make sense to you?
There was a problem hiding this comment.
Yes, changed to your phrasing via force push.
|
Thanks! |
cuviper
reviewed
Dec 13, 2023
rayon-core/src/thread_pool/mod.rs
Outdated
| /// fn main() { | ||
| /// rayon::ThreadPoolBuilder::new().num_threads(1).build_global().unwrap(); | ||
| /// let pool = rayon::ThreadPoolBuilder::default().build().unwrap(); | ||
| /// (0..3).into_par_iter().for_each(|_| { |
There was a problem hiding this comment.
Oh, we can't use APIs from rayon proper while testing rayon-core. Maybe you can make the example with join instead?
There was a problem hiding this comment.
Foiled! Rewritten to use join() as requested.
cuviper
reviewed
Dec 13, 2023
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.
Add documentation to
rayon::ThreadPool::install()warning about implicit yield behavior, as discussed in #1105.