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.

Sign up for GitHub

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

Jump to bottom

io: document default ReaderStream capacity #7147

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

io: document default ReaderStream capacity #7147

wants to merge 1 commit into from

Conversation

Owez
Copy link

@Owez Owez commented Feb 8, 2025 •
edited
Loading

Motivation

I had to read the source to figure out the default ReaderStream capacity

Solution

Add a little docstring line to the typical ::new() for ReaderStream to document. DEFAULT_CAPACITY is private, we could alternatively publicise it and link in the docstring to it?

@maminrayej maminrayej added T-docs Topic: documentation A-tokio-util Area: The tokio-util crate labels Feb 8, 2025
@maminrayej
Copy link
Member

maminrayej commented Feb 10, 2025 •
edited
Loading

Thanks for the PR.

I believe changing 4KiB to 4 KiB will fix the check-spelling job.

@Owez
Copy link
Author

Owez commented Feb 10, 2025

Thanks for the PR.

I believe changing 4KiB to 4 KiB will fix the check-spelling job.

Oh yeah, will do :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
A-tokio-util Area: The tokio-util crate T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Owez @maminrayej