io: clarify the zero capacity case of AsyncRead::poll_read#7580
Merged
ADD-SP merged 1 commit intotokio-rs:masterfrom Sep 6, 2025
Merged
io: clarify the zero capacity case of AsyncRead::poll_read#7580ADD-SP merged 1 commit intotokio-rs:masterfrom
AsyncRead::poll_read#7580ADD-SP merged 1 commit intotokio-rs:masterfrom
Conversation
5b9a290 improved the trait documentation for the cases when the buf length didn't change but forgot to do the same for the method documentation. Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
ADD-SP
added
T-docs
ADD-SP
changed the title
AsyncRead::poll_read
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
5b9a290 improved the trait documentation for the cases when the buf length didn't change but forgot to do the same for the method documentation.
Solution
Apply the improvement also for the method documentation.