[DOC] Improve thread::panicking documentaion.
#41811
Merged
Conversation
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
gamazeps
changed the title
thread::panicking documentaion.thread::panicking documentaion.
frewsxcv
reviewed
May 7, 2017
src/libstd/thread/mod.rs
Outdated
| /// unsafe code, by checking `panicking` when the `drop` is called. | ||
| /// | ||
| /// This is usually not needed when writing safe code, as [`Mutex`s][Mutex] | ||
| /// already poison themselve when a thread panicks while holding the lock. |
There was a problem hiding this comment.
[00:02:03] tidy error: /checkout/src/libstd/thread/mod.rs:465: trailing whitespace
There was a problem hiding this comment.
Damn, that is valid mardown though T_T.
Will remove them
frewsxcv
added
the
A-docs
kennytm
requested changes
May 7, 2017
src/libstd/thread/mod.rs
Outdated
| @@ -458,6 +458,16 @@ pub fn yield_now() { | |||
|
|
|||
| /// Determines whether the current thread is unwinding because of panic. | |||
| /// | |||
| /// A common use of this feature is to poison shared ressources when writing | |||
src/libstd/thread/mod.rs
Outdated
| /// A common use of this feature is to poison shared ressources when writing | ||
| /// unsafe code, by checking `panicking` when the `drop` is called. | ||
| /// | ||
| /// This is usually not needed when writing safe code, as [`Mutex`s][Mutex] |
src/libstd/thread/mod.rs
Outdated
| /// unsafe code, by checking `panicking` when the `drop` is called. | ||
| /// | ||
| /// This is usually not needed when writing safe code, as [`Mutex`s][Mutex] | ||
| /// already poison themselve when a thread panicks while holding the lock. |
gamazeps
force-pushed
the
thread-panicking-doc
branch
from
0fcc053 to
12efc9d
Compare
|
this is a great improvement, thanks so much for this! always love to see the api docs expanded describing various use cases of the functionality 👌 @bors r+ rollup |
|
📌 Commit 12efc9d has been approved by |
bors
added a commit
that referenced
this pull request
May 7, 2017
[DOC] Improve `thread::panicking` documentaion. Part of #29378 Takes care of: `panicking` could use some more advice on when to use this. I mays have done a poor choice of introducing `Mutex`s. r? @steveklabnik
|
☀️ Test successful - status-appveyor, status-travis |
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
Takes care of:
panickingcould use some more advice on when to use this.I mays have done a poor choice of introducing
Mutexs.r? @steveklabnik