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

Change AsyncReadExt::read docs formatting to clarify requirements #7066

Merged
merged 1 commit into from
Jan 4, 2025

Conversation

AeonSolstice
Copy link
Contributor

Motivation

I was reading the docs for the method, and in its current state, it read to me as:

No guarantees are provided about the contents of buf when this function is called, implementations cannot rely on [any] property [of] the contents of buf being true.

With the inline block formatting on true, it makes it seem that you must not rely on buf containing the value true.

Solution

Remove the inline block formatting on true, as we are not talking about the boolean value true in code.

@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate M-io Module: tokio/io labels Jan 4, 2025
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 2353806 into tokio-rs:master Jan 4, 2025
88 checks passed
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