Update Utf8JsonReader ValueSpan, Sequence, and ValueTextEquals docs. #3142
Conversation
This file contains hidden or 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
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
ahsonkhan
commented
Sep 9, 2019
carlossanlop
requested review from
GrabYourPitchforks,
jozkee,
mairaw,
rpetrusha and
steveharter
carlossanlop
added
🏁 Release: .NET Core 3.0
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
suggested changes
Sep 9, 2019
Contributor
carlossanlop
left a comment
carlossanlop
left a comment
There was a problem hiding this comment.
Left a few comments, @ahsonkhan. Let's also wait for @rpetrusha / @mairaw to comment.
rpetrusha
suggested changes
Sep 9, 2019
rpetrusha
left a comment
rpetrusha
left a comment
There was a problem hiding this comment.
Thanks for these updates and corrections, @ahsonkhan. I've left some comments for you to consider, along with a few suggestions.
mairaw
reviewed
Sep 9, 2019
jozkee
reviewed
Sep 9, 2019
jozkee
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
carlossanlop
reviewed
Sep 9, 2019
Contributor
Author
|
I have addressed all the feedback that I thought was actionable and made judgement calls for some others. Please take a look. Tyvm for the review :) |
carlossanlop
approved these changes
Sep 10, 2019
Contributor
carlossanlop
left a comment
carlossanlop
left a comment
There was a problem hiding this comment.
Left two suggestions (see cref => xref, in remarks). Other than that, it looks good.
After you merge the suggestions, let's wait for the build to finish and @mairaw / @rpetrusha 's approval so we can commit.
jozkee
reviewed
Sep 10, 2019
jozkee
reviewed
Sep 10, 2019
jozkee
reviewed
Sep 10, 2019
jozkee
reviewed
Sep 10, 2019
Contributor
Author
|
Anything left to do or is this good to merge? |
mairaw
reviewed
Sep 10, 2019
| Therefore, if the input is untrusted or not previously validated, call <xref:System.Text.Json.Utf8JsonReader.GetString> to get the JSON string token. | ||
| ## Remarks | ||
| Since this property returns the raw bytes, avoid using it for text comparison. Instead call <xref:System.Text.Json.Utf8JsonReader.ValueTextEquals%2A> which will unescape the text if necessary. |
Contributor
There was a problem hiding this comment.
Suggested change
| Since this property returns the raw bytes, avoid using it for text comparison. Instead call <xref:System.Text.Json.Utf8JsonReader.ValueTextEquals%2A> which will unescape the text if necessary. | |
| Since this property returns the raw bytes, avoid using it for text comparison. Instead call <xref:System.Text.Json.Utf8JsonReader.ValueTextEquals%2A>, which unescapes the text if necessary. |
Contributor
Author
|
Changes look good. |
mairaw
removed
the
waiting-on-reviews
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 #2898
Also, other fixes around consistency and correctness.
cc @mairaw, @GrabYourPitchforks, @carlossanlop