io: clarify clear_ready and clear_ready_matching documentation
#6304
Conversation
This file contains 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
maminrayej
added
T-docs
Darksonn
reviewed
Jan 25, 2024
Darksonn
reviewed
Jan 25, 2024
tokio/src/io/async_fd.rs
Outdated
Comment on lines
830
to
831
| /// Note that that if a readiness notification occurs following the last operation | ||
| /// but prior to invoking `clear_ready`, it will not be cleared. |
There was a problem hiding this comment.
I think it's really important to be very clear in the wording here, because the point we are making is tricky to understand.
Here's one suggested wording. This one tries to explain it twice with "in other words". I still don't love it though.
Suggested change
| /// Note that that if a readiness notification occurs following the last operation | |
| /// but prior to invoking `clear_ready`, it will not be cleared. | |
| /// This method only clears readiness events that happened before the creation of this guard. In other words, if the IO resource becomes ready between the creation of the guard and this call to `clear_ready`, then the readiness is not actually cleared. |
There was a problem hiding this comment.
I actually like that the timing is tied to the creation of the guard. I believe it makes it clear.
Darksonn
reviewed
Jan 27, 2024
tokio/src/io/async_fd.rs
Outdated
Comment on lines
842
to
844
| /// This implies that if a readiness notification occurs following the last operation | ||
| /// but prior to invoking `clear_ready`, it will not be cleared. | ||
| /// |
There was a problem hiding this comment.
This part isn't on all of them? But I think the other change is probably sufficient.
There was a problem hiding this comment.
Ah yes it was a leftover comment. Thanks.
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.
Resolves #6302.