Doc Rectification #204
Open
Doc Rectification #204
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
BurntSushi
reviewed
Jan 3, 2025
| @@ -565,7 +565,7 @@ pub fn validate(slice: &[u8]) -> Result<(), Utf8Error> { | |||
| /// | |||
| /// When unsuccessful, `None` is returned along with the number of bytes that | |||
| /// make up a maximal prefix of a valid UTF-8 code unit sequence. In this case, | |||
| /// the number of bytes consumed is always between 0 and 3, inclusive, where | |||
| /// the number of bytes consumed is always between 1 and 3, inclusive, where | |||
There was a problem hiding this comment.
This still doesn't flow right to me. Because we say between "1 and 3," but then use language as if we said "0 and 3."
There was a problem hiding this comment.
Okay. How about the below one:
When unsuccessful, None is returned along with the number of bytes that make up a maximal prefix of a valid UTF-8 code unit sequence. This number will always be at least 1 byte, as the function will always consume at least one byte from the input slice.
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.
Fixes #139
Doc Changes