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.

Sign up for GitHub

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

document effect of join on memory ordering #53389

Merged
merged 2 commits into from
Aug 31, 2018
Merged

document effect of join on memory ordering #53389

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34b65db
document effect of join on memory ordering
RalfJung Aug 15, 2018
31b63d0
split paragraph
RalfJung Aug 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/libstd/thread/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1308,13 +1308,17 @@ impl<T> JoinHandle<T> {
&self.0.thread
}

/// Waits for the associated thread to finish.
/// Waits for the associated thread to finish. In terms of [atomic memory orderings],
Copy link
Member

Choose a reason for hiding this comment

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

Could you move the new text to a separate paragraph? The first paragraph shows up as a summary in search results so we like to keep it short. LGTM otherwise.

/// the completion of the associated thread synchronizes with this function returning.
/// In other words, all operations performed by that thread are ordered before all
/// operations that happen after `join` returns.
///
/// If the child thread panics, [`Err`] is returned with the parameter given
/// to [`panic`].
///
/// [`Err`]: ../../std/result/enum.Result.html#variant.Err
/// [`panic`]: ../../std/macro.panic.html
/// [atomic memory orderings]: ../../std/sync/atomic/index.html
///
/// # Panics
///
Expand Down