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

std::sync::RwLock docs improvement #44778

Merged
merged 1 commit into from
Sep 23, 2017
Merged

std::sync::RwLock docs improvement #44778

merged 1 commit into from
Sep 23, 2017

Conversation

lorepozo
Copy link
Contributor

Addresses the RwLock part of #29377.
r? @steveklabnik

Added examples, links to types, and a small comparison between RwLock and Mutex.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

estebank
estebank requested changes Sep 23, 2017
View reviewed changes
src/libstd/sync/rwlock.rs
/// to allow access to the contained of the lock.
/// required that `T` satisfies [`Send`] to be shared across threads and
/// [`Sync`] to allow concurrent access through readers. The RAII guards
/// returned from the locking methods implement [`Deref`][] (and [`DerefMut`]
Copy link
Contributor

Choose a reason for hiding this comment

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

typo

[`Deref`][]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@estebank It was intentional — without the [], the parentheses are parsed as the markdown syntax for a URL. e.g. in sync::mpsc::Receiver

Copy link
Contributor

Choose a reason for hiding this comment

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

TIL

@estebank estebank added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Sep 23, 2017
@estebank
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 23, 2017

📌 Commit f283875 has been approved by estebank

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Sep 23, 2017
@frewsxcv
Rollup merge of rust-lang#44778 - lucasem:master, r=estebank
2aa42ef 
std::sync::RwLock docs improvement

Addresses the `RwLock` part of rust-lang#29377.
r? @steveklabnik

Added examples, links to types, and a small comparison between RwLock and Mutex.
@frewsxcv frewsxcv mentioned this pull request Sep 23, 2017
Merged
bors added a commit that referenced this pull request Sep 23, 2017
@bors
Auto merge of #44784 - frewsxcv:rollup, r=frewsxcv
85a5d3f 
Rollup of 14 pull requests

- Successful merges: #44554, #44648, #44658, #44712, #44717, #44726, #44745, #44746, #44749, #44759, #44770, #44773, #44776, #44778
- Failed merges:
@bors bors merged commit f283875 into rust-lang:master Sep 23, 2017
@lorepozo lorepozo mentioned this pull request Sep 23, 2017
Closed
31 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@estebank estebank estebank approved these changes

Assignees

@steveklabnik steveklabnik

Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lorepozo @rust-highfive @estebank @bors @steveklabnik