[Doc] Expands `detach` documentation in `thread::JoinHande`. #41981

gamazeps · 2017-05-13T19:24:31Z

Part of #29378 .

Adds an example of a thread detaching.
Expands what detaching means.

nagisa · 2017-05-14T02:55:43Z

src/libstd/thread/mod.rs

+/// println!("Original thread is joined.");
+/// // We make sure that the child thread has time to run, before the main
+/// // thread returns.
+/// thread::sleep(Duration::from_millis(1000));


The example could be simplified with a plain scope or function instead of spawning two threads.

There’s no parent-child relationship between the threads in a process.

The example could indeed be simplified to

fn main() { { thread::spawn(||{ thread::sleep(Duration::from_millis(10)); println!("hey"); }); } thread::sleep(Duration::from_millis(1000)); }

But this is not a form that I have ever encountered in real rust code, thus this example would not be very helpful.
On the other hand a thread spawning a new thread and being joined before the new thread is a behaviour that is encountered in real rust code. It is thus a bit more complex than needed, but I believe that it is also more helpful.

There are indeed no parent-child relationship between thread, this just seemed a good illustration, if you have a better name in mind I'll change for it.

Well, the current example seems fine to me. But if improvements are possible, I'm open to it as long as it's easy to understand for readers.

I am happy with either.

Changed the child notation for spawned or associated.

On the other hand I still believe the current example to more helpful.

gamazeps · 2017-05-14T11:53:09Z

r? @rust-lang/docs

steveklabnik · 2017-05-15T13:44:16Z

src/libstd/thread/mod.rs

+///
+/// let _ = original_thread.join();
+/// println!("Original thread is joined.");
+/// // We make sure that the child thread has time to run, before the main


could you put an extra newline above here

steveklabnik · 2017-05-15T13:44:36Z

src/libstd/thread/mod.rs

+/// let _ = original_thread.join();
+/// println!("Original thread is joined.");
+/// // We make sure that the child thread has time to run, before the main
+/// // thread returns.


and below here, please? that is, an empty ///. This feels a bit cramped.

steveklabnik · 2017-05-15T13:44:56Z

src/libstd/thread/mod.rs

+/// println!("Original thread is joined.");
+/// // We make sure that the child thread has time to run, before the main
+/// // thread returns.
+/// thread::sleep(Duration::from_millis(1000));


I am happy with either.

gamazeps · 2017-05-16T12:02:51Z

Done :)

Mark-Simulacrum · 2017-05-20T23:27:59Z

@steveklabnik I think this is ready for another review and should be ready to go.

frewsxcv · 2017-05-24T02:12:20Z

src/libstd/thread/mod.rs

@@ -1052,6 +1053,30 @@ impl<T> JoinInner<T> {
 /// }).unwrap();
 /// ```
 ///
+/// Child being detached and outliving its parent:
+///
+/// ```


This should be marked no_run so we compile the code but don't run it during tests (we don't want this test to take a full second)

see also: https://doc.rust-lang.org/nightly/book/first-edition/documentation.html#running-documentation-tests

steveklabnik

r=me after the change @frewsxcv mentioned, thank you!

alexcrichton · 2017-06-01T15:55:05Z

ping @gamazeps, just wanted to make sure this was still on your radar!

gamazeps · 2017-06-01T15:57:49Z

@alexcrichton and you were right to do so :)

Part of rust-lang#29378 . - Adds an example of a thread detaching. - Expands what `detaching` means.

gamazeps · 2017-06-02T10:26:48Z

Done :)

frewsxcv · 2017-06-02T14:53:07Z

@bors r+ rollup

bors · 2017-06-02T14:53:08Z

📌 Commit b76b9e1 has been approved by frewsxcv

@steveklabnik

[Doc] Expands `detach` documentation in `thread::JoinHande`. Part of rust-lang#29378 . - Adds an example of a thread detaching. - Expands what `detaching` means. r? @steveklabnik

Rollup of 10 pull requests - Successful merges: #41981, #42225, #42310, #42319, #42335, #42343, #42355, #42360, #42370, #42372 - Failed merges:

rust-highfive assigned steveklabnik May 13, 2017

gamazeps changed the title ~~Expands detach documentation in thread::JoinHande.~~ [Doc] Expands detach documentation in thread::JoinHande. May 13, 2017

nagisa reviewed May 14, 2017

View reviewed changes

rust-highfive unassigned steveklabnik May 14, 2017

Mark-Simulacrum assigned steveklabnik May 14, 2017

Mark-Simulacrum added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 14, 2017

frewsxcv added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label May 14, 2017

steveklabnik reviewed May 15, 2017

View reviewed changes

gamazeps force-pushed the thread-detach branch 2 times, most recently from 72f33b3 to c60ec47 Compare May 15, 2017 14:19

frewsxcv reviewed May 24, 2017

View reviewed changes

steveklabnik reviewed May 24, 2017

View reviewed changes

carols10cents added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 29, 2017

Expands detach documentation in thread::JoinHande.

b76b9e1

Part of rust-lang#29378 . - Adds an example of a thread detaching. - Expands what `detaching` means.

gamazeps force-pushed the thread-detach branch from c60ec47 to b76b9e1 Compare June 2, 2017 10:26

Mark-Simulacrum mentioned this pull request Jun 2, 2017

Rollup of 10 pull requests #42381

Merged

bors added a commit that referenced this pull request Jun 2, 2017

Auto merge of #42381 - Mark-Simulacrum:rollup, r=Mark-Simulacrum

536e9b8

Rollup of 10 pull requests - Successful merges: #41981, #42225, #42310, #42319, #42335, #42343, #42355, #42360, #42370, #42372 - Failed merges:

bors added a commit that referenced this pull request Jun 2, 2017

Auto merge of #42381 - Mark-Simulacrum:rollup, r=Mark-Simulacrum

bb907ad

Rollup of 10 pull requests - Successful merges: #41981, #42225, #42310, #42319, #42335, #42343, #42355, #42360, #42370, #42372 - Failed merges:

bors merged commit b76b9e1 into rust-lang:master Jun 3, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Expands `detach` documentation in `thread::JoinHande`. #41981

[Doc] Expands `detach` documentation in `thread::JoinHande`. #41981

gamazeps commented May 13, 2017

nagisa May 14, 2017

gamazeps May 14, 2017 •

edited

Loading

GuillaumeGomez May 14, 2017

steveklabnik May 15, 2017

gamazeps May 15, 2017

gamazeps commented May 14, 2017 •

edited by GuillaumeGomez

Loading

steveklabnik May 15, 2017

gamazeps May 15, 2017

steveklabnik May 15, 2017

gamazeps May 15, 2017

steveklabnik May 15, 2017

gamazeps commented May 16, 2017

Mark-Simulacrum commented May 20, 2017

frewsxcv May 24, 2017

steveklabnik left a comment

alexcrichton commented Jun 1, 2017

gamazeps commented Jun 1, 2017

gamazeps commented Jun 2, 2017

frewsxcv commented Jun 2, 2017

bors commented Jun 2, 2017

[Doc] Expands detach documentation in thread::JoinHande. #41981

[Doc] Expands detach documentation in thread::JoinHande. #41981

Conversation

gamazeps commented May 13, 2017

Choose a reason for hiding this comment

gamazeps May 14, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gamazeps commented May 14, 2017 • edited by GuillaumeGomez Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gamazeps commented May 16, 2017

Mark-Simulacrum commented May 20, 2017

Choose a reason for hiding this comment

steveklabnik left a comment

Choose a reason for hiding this comment

alexcrichton commented Jun 1, 2017

gamazeps commented Jun 1, 2017

gamazeps commented Jun 2, 2017

frewsxcv commented Jun 2, 2017

bors commented Jun 2, 2017

[Doc] Expands `detach` documentation in `thread::JoinHande`. #41981

[Doc] Expands `detach` documentation in `thread::JoinHande`. #41981

gamazeps May 14, 2017 •

edited

Loading

gamazeps commented May 14, 2017 •

edited by GuillaumeGomez

Loading