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

improve Builder::max_frame_length docs #4352

Merged
merged 1 commit into from
Dec 28, 2021
Merged

improve Builder::max_frame_length docs #4352

merged 1 commit into from
Dec 28, 2021

Conversation

dvdsk
Copy link
Contributor

@dvdsk dvdsk commented Dec 28, 2021 •
edited by Darksonn
Loading

A tiny tweak to the documentation fixing #4340 by:

  • modifying the example to set the length to 8MB instead of 8KB
  • mentions the frame length is set in bytes

Closes: #4340

@Darksonn Darksonn added A-tokio-util Area: The tokio-util crate M-codec Module: tokio-util/codec T-docs Topic: documentation labels Dec 28, 2021
@Darksonn
Copy link
Contributor

Thanks.

@Darksonn Darksonn merged commit dc18941 into tokio-rs:master Dec 28, 2021
@tobz tobz mentioned this pull request Feb 10, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn approved these changes

Assignees
No one assigned
Labels
A-tokio-util Area: The tokio-util crate M-codec Module: tokio-util/codec T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Misleading documentation for Builder::max_frame_length.
2 participants
@dvdsk @Darksonn