Wrong param name in an overload for System.Text.Json.Utf8JsonReader.ValueTextEquals #2966
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
carlossanlop
added
the
waiting-on-reviews
rpetrusha
approved these changes
Aug 8, 2019
rpetrusha
left a comment
rpetrusha
left a comment
There was a problem hiding this comment.
Interesting. I wonder how the disparity happened. In any case, this looks good, and text is consistent with both source and all of the signature data in the XML. I'll merge your PR now, @carlossanlop.
rpetrusha
removed
the
waiting-on-reviews
Contributor
Author
We've seen this happen before, right @mairaw? It happens when the parameter name is changed in src but not in the ref. |
Contributor
|
Not in this case. I think we overlooked this change in PR #2890 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The param name was not matching the one in the signatures (lines 1572 and 1587 within the same file), so I changed it so it stops showing up as undocumented in the Excel file. It also matches the source file:
src/System/Text/Json/Reader/Utf8JsonReader.cs#L502
Note: Even though the param description does not match the one in the triple slash comments (we added "utf-8"), after I looked at the code, it seems that the text is going to be compared as utf8 anyway.