-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Rewrote the thread struct docs #41543
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -713,22 +713,27 @@ struct Inner { | |
|
||
#[derive(Clone)] | ||
#[stable(feature = "rust1", since = "1.0.0")] | ||
/// A handle to a thread. | ||
/// A handle to a thread, its just an abstract reference and as such | ||
/// it can be used to identify a thread (by name, for example). In most | ||
/// usage cases, this struct is not used directly. | ||
|
||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// use std::thread; | ||
|
||
/// | ||
/// let handler = thread::Builder::new() | ||
/// .name("foo".into()) | ||
/// .spawn(|| { | ||
/// let thread = thread::current(); | ||
/// println!("thread name: {}", thread.name().unwrap()); | ||
/// for i in 0..5 { | ||
/// let thread_name = format!("thread_{}", i); | ||
/// thread::Builder::new() | ||
|
||
/// .name(thread_name) // Now you can identify which thread panicked | ||
/// // thanks to the handle's name | ||
|
||
/// .spawn(move || { | ||
/// if i == 3 { | ||
/// panic!("I'm scared!!!"); | ||
/// } | ||
/// }) | ||
/// .unwrap(); | ||
/// | ||
/// handler.join().unwrap(); | ||
/// } | ||
/// ``` | ||
pub struct Thread { | ||
inner: Arc<Inner>, | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"just" is a poor word for docs; this becomes better just dropping it.
Also, this summary is quite long; I think keeping the initial summary is fine, and putting this after: