codec: docs: fix length_delimited doc description and make examples testable #6638
Conversation
This file contains 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
name1e5s
force-pushed
the
chore/length_delimited_docfix
branch
from
7f10313
to
50d98d6
Compare
mox692
added
T-docs
Darksonn
reviewed
Jun 15, 2024
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
mox692
reviewed
Jun 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
According to comment in #6604, some examples for
length_delimiteddo not fit the real behavior. This PR fix the document and add tests to the examples.Close #6604
Solution
Fix the docs.
Swap the order of example 1 and 2 to make it more easier to understand.