Skip to content

Conversation

@martin-g
Copy link
Member

@martin-g martin-g commented Sep 5, 2025

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.

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 ADD-SP added T-docs Topic: documentation A-tokio Area: The main tokio crate M-io Module: tokio/io labels Sep 6, 2025
Copy link
Member

@ADD-SP ADD-SP left a comment

Choose a reason for hiding this comment

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

Thanks!

@ADD-SP ADD-SP changed the title docs: Synchronize the docs of poll_read() with the trait documentation io: clarify the zero capacity case of AsyncRead::poll_read Sep 6, 2025
@ADD-SP ADD-SP merged commit c6aceed into tokio-rs:master Sep 6, 2025
102 checks passed
@martin-g martin-g deleted the synchronize-async_read_docs branch September 7, 2025 20:22
@Darksonn Darksonn mentioned this pull request Oct 14, 2025
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.

2 participants