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

Make oneshot::Sender::poll_closed public again #3032

Merged
merged 2 commits into from Oct 26, 2020
Merged

Make oneshot::Sender::poll_closed public again #3032

merged 2 commits into from Oct 26, 2020

Conversation

seanmonstar
Copy link
Member

No description provided.

Darksonn
Darksonn reviewed Oct 23, 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 would prefer to not make it #[doc(hidden)].

@Darksonn Darksonn added A-tokio Area: The main tokio crate C-enhancement Category: A PR with an enhancement or bugfix. M-sync Module: tokio/sync labels Oct 23, 2020
@seanmonstar
Copy link
Member Author

We can add docs, I just made it doc(hidden) to try to land it with less fuss. 🤷

@seanmonstar seanmonstar mentioned this pull request Oct 24, 2020
Closed
5 tasks
@carllerche
Copy link
Member

I'm fine making this public, but we should include decent API docs w/ an example :) (and not make it doc hidden).

@Darksonn
Copy link
Contributor

Darksonn commented Oct 26, 2020 •
edited

I submitted a commit with documentation. It also moves the poll_closed method such that it appears in a better order in the generated documentation.

carllerche
carllerche approved these changes Oct 26, 2020
View reviewed changes
Copy link
Member

@carllerche carllerche left a comment

Choose a reason for hiding this comment

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

👍 thanks

@carllerche carllerche merged commit 6d0ba19 into master Oct 26, 2020
@carllerche carllerche deleted the oneshot-poll-closed branch October 26, 2020 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn left review comments

@carllerche carllerche carllerche approved these changes

Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-enhancement Category: A PR with an enhancement or bugfix. M-sync Module: tokio/sync
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@seanmonstar @carllerche @Darksonn