[Doc] Improve thread::spawn documentation#41854
Merged
bors merged 5 commits intorust-lang:masterfrom May 10, 2017
Merged
Conversation
steveklabnik
reviewed
May 9, 2017
Contributor
steveklabnik
left a comment
There was a problem hiding this comment.
a few small changes please! Thanks for this, looks great!
src/libstd/thread/mod.rs
Outdated
| /// ``` | ||
| /// | ||
| /// As mentionned in the module documentation, threads are usualy made to | ||
| /// communicate using [`channel`s][`channels`], here is how it usually looks. |
Contributor
There was a problem hiding this comment.
this should work without the second set of []s by using the same text below
src/libstd/thread/mod.rs
Outdated
| /// | ||
| /// # Examples | ||
| /// | ||
| /// Simple thread creation. |
Contributor
There was a problem hiding this comment.
Could we say
Creating a thread:
instead here? I try to stick away from "simple" 😄
Contributor
Author
|
Done :) |
Contributor
once this is fixed we should be good to go! |
Contributor
Author
|
Done :) |
parir
reviewed
May 9, 2017
src/libstd/thread/mod.rs
Outdated
| /// handler.join().unwrap(); | ||
| /// ``` | ||
| /// | ||
| /// As mentionned in the module documentation, threads are usualy made to |
Contributor
There was a problem hiding this comment.
s/mentionned/mentioned/
s/usualy/usually/
Contributor
|
@bors: r+ rollup |
Collaborator
|
📌 Commit fe7b6db has been approved by |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
May 10, 2017
…labnik [Doc] Improve `thread::spawn` documentation Part of rust-lang#29378 - Add two examples to `thread::spawn` doumentation that show common uses of threads. - Add a link to `thread::Builder` in the `thread::spawn` documentation for configuring threads. - Add a link to `thread::spawn` in `thread::Builder` in order to avoid documentation duplication. r? @steveklabnik
This file contains hidden or 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
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.
Part of #29378
thread::spawndoumentation that show common uses of threads.thread::Builderin thethread::spawndocumentation for configuring threads.thread::spawninthread::Builderin order to avoid documentation duplication.r? @steveklabnik