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

show mutex module doc, add method examples #2405

Merged
merged 12 commits into from
Apr 21, 2020
Merged

show mutex module doc, add method examples #2405

merged 12 commits into from
Apr 21, 2020

Conversation

jxs
Copy link
Member

@jxs jxs commented Apr 14, 2020

Motivation

Mutex module doc is not showing, doc is using inner doc comments, but the Mutex mod is private

Solution

this PR makes it visible again by switching the inner doc comments with outer doc comments.
This Pr also adds examples to Mutex's methods

taiki-e
taiki-e reviewed Apr 14, 2020
View reviewed changes
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
Darksonn
Darksonn reviewed Apr 14, 2020
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

I have a few comments.

tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
jxs and others added 2 commits April 14, 2020 15:58
Darksonn
Darksonn reviewed Apr 15, 2020
View reviewed changes
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
@jxs
Copy link
Member Author

jxs commented Apr 15, 2020

updated

@Darksonn
Copy link
Contributor

It looks like you have some failing tests.

@jxs
Copy link
Member Author

jxs commented Apr 15, 2020

thanks, updated.
Apparently TryLockError was not public, made it so by exporting it in the sync mod

@jonhoo jonhoo added A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-sync Module: tokio/sync S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-docs Topic: documentation labels Apr 17, 2020
@jxs jxs requested a review from Darksonn April 20, 2020 19:24
Darksonn
Darksonn reviewed Apr 20, 2020
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

I compiled it locally and had a read-through. I have commented anything I noticed grammar-wise below.

tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
@Darksonn Darksonn added S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 20, 2020
@jxs jxs requested a review from Darksonn April 20, 2020 21:42
taiki-e
taiki-e reviewed Apr 21, 2020
View reviewed changes
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
@jxs @taiki-e
Update tokio/src/sync/mutex.rs
b220013 
Co-Authored-By: Taiki Endo <te316e89@gmail.com>
Darksonn
Darksonn reviewed Apr 21, 2020
View reviewed changes
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
@jxs jxs requested a review from Darksonn April 21, 2020 13:01
Darksonn
Darksonn approved these changes Apr 21, 2020
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

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

I think this looks good now. 👍

@Darksonn
Copy link
Contributor

@taiki-e Do you want another chance at reviewing this before I merge it?

taiki-e
taiki-e approved these changes Apr 21, 2020
View reviewed changes
Copy link
Member

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

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

LGTM aside from a few small nits.

tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
tokio/src/sync/mutex.rs Outdated Show resolved Hide resolved
jxs and others added 2 commits April 21, 2020 18:07
@jxs jxs requested a review from taiki-e April 21, 2020 17:29
@Darksonn Darksonn merged commit 6349efd into tokio-rs:master Apr 21, 2020
@Darksonn Darksonn removed the S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. label Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taiki-e taiki-e taiki-e approved these changes

@Darksonn Darksonn Darksonn approved these changes

Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-sync Module: tokio/sync T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jxs @Darksonn @taiki-e @jonhoo