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.

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

io: remove PollEvented docs reference to clear_read_ready #4931

Merged
merged 1 commit into from Aug 23, 2022

Conversation

hds
Copy link
Contributor

@hds hds commented Aug 22, 2022

Motivation

The (internal) docs for PollEvented still had a single reference to
Registration::clear_read_ready left (the others had been removed in
#3957). With this change we should be able to close the original issue.

Closes #3746

Solution

The documentation forPollEvented had a single remaining reference to
Registration::clear_read_ready, which no longer exists. This change
updates the documentation to refer to Registration::clear_readiness
instead.

The documentation for`PollEvented` had a single remaining reference to
`Registration::clear_read_ready`, which no longer exists. This change
updates the documentation to refer to `Registration::clear_readiness`
instead.
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-io Module: tokio/io T-docs Topic: documentation labels Aug 23, 2022
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.

Thanks.

@Darksonn Darksonn merged commit e005b6c into master Aug 23, 2022
@Darksonn Darksonn deleted the hds/docs-poll-evented branch August 23, 2022 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix documentation of PollEvented
2 participants