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

Jump to bottom

[Doc] Implrove thread::Builder's doc. #41994

Merged
merged 1 commit into from
May 16, 2017
Merged

[Doc] Implrove thread::Builder's doc. #41994

merged 1 commit into from
May 16, 2017

Conversation

gamazeps
Copy link
Contributor

Part of #29378 .

  • Explains why we would use the builder instead ofthe free function.
  • Changes the parent-child explanation for a spawned-caller in thread::Builder::spawn
  • Adds a link to io::Result in thread::Builder
  • Corrects the return type doc in thread::Builder::spawn

r? @rust-lang/docs

GuillaumeGomez
GuillaumeGomez requested changes May 14, 2017
View reviewed changes
src/libstd/thread/mod.rs Outdated
/// be overriden by the OS.
///
/// If the [`stack_size`] field is not specified, the stack size
/// will be the `RUST_MIN_STACK` environment variable. If it is
Copy link
Member

Choose a reason for hiding this comment

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

Extra whitespace before "If it is".

src/libstd/thread/mod.rs Outdated
///
/// If the [`stack_size`] field is not specified, the stack size
/// will be the `RUST_MIN_STACK` environment variable. If it is
/// not specified either, a sensible default will be set (2MB as
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure we should give the default value. Especially if it can change depending the platform/architecture.

@gamazeps gamazeps force-pushed the thread-builder branch 2 times, most recently from e9b04c9 to c8ff6f5 Compare May 14, 2017 18:09
@gamazeps
Copy link
Contributor Author

Done :)

GuillaumeGomez
GuillaumeGomez reviewed May 14, 2017
View reviewed changes
src/libstd/thread/mod.rs Outdated
/// [`io::Result`] to the thread handle with the given configuration.
///
/// The [`thread::spawn`] free function uses a `Builder` with default
/// configuration and `unwrap`s its return value.
Copy link
Member

Choose a reason for hiding this comment

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

Missing link to the unwrap method. :p

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done :p

Improve thread::Builder documentation.
a51777e 
Part of rust-lang#29378 .

- In particular explains *why* we would use the builder instead of
  the free function.
- Changes the parent-child explanation for a spawned-caller.
- Add link to `io::Result` in `thread::Builder`
- Corrects the `thread::Builder::spawn` documentation.
@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented May 14, 2017

📌 Commit a51777e has been approved by GuillaumeGomez

@frewsxcv frewsxcv added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label May 14, 2017
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 14, 2017
@Mark-Simulacrum
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
215a753 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request May 14, 2017
Closed
@carols10cents carols10cents added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label May 15, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 15, 2017
@frewsxcv
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
d4545f6 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@frewsxcv frewsxcv mentioned this pull request May 15, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 15, 2017
@frewsxcv
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
0c4f3c0 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@frewsxcv frewsxcv mentioned this pull request May 15, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 16, 2017
@frewsxcv
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
459a3af 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@frewsxcv frewsxcv mentioned this pull request May 16, 2017
Closed
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 16, 2017
@Mark-Simulacrum
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
b5a24d4 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request May 16, 2017
Closed
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 16, 2017
@Mark-Simulacrum
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
18171a8 
…eGomez

[Doc] Implrove `thread::Builder`'s doc.

Part of rust-lang#29378 .

- Explains *why* we would use the builder instead ofthe free function.
- Changes the parent-child explanation for a spawned-caller in `thread::Builder::spawn`
- Adds a link to `io::Result` in `thread::Builder`
- Corrects the return type doc in `thread::Builder::spawn`

r? @rust-lang/docs
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request May 16, 2017
Merged
bors added a commit that referenced this pull request May 16, 2017
@bors
Auto merge of #42038 - Mark-Simulacrum:rollup, r=Mark-Simulacrum
0f68728 
Rollup of 8 pull requests

- Successful merges: #41489, #41982, #41994, #41995, #42001, #42005, #42011, #42028
- Failed merges:
@bors bors merged commit a51777e into rust-lang:master May 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gamazeps @GuillaumeGomez @bors @carols10cents @frewsxcv