Fix Utf8JsonWriter WriteXValue methods documentation to remove array-specific language #11476
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
WriteXValue
methods inUtf8JsonWriter
had documentation that incorrectly stated they write values "as an element of a JSON array". However, these methods can be used in various contexts, not just arrays:[value1, value2, value3]
{"property": value}
Example from the issue
The problem was evident in custom converters like this:
Changes made
Updated documentation for all affected
WriteXValue
methods to remove the misleading "as an element of a JSON array" language:DateTime
,DateTimeOffset
,Guid
,ReadOnlySpan<byte>
,ReadOnlySpan<char>
,string
,JsonEncodedText
Decimal
,Double
,Int32
,Int64
,Single
,UInt32
,UInt64
Before and after
Before:
After:
The documentation now accurately reflects that these methods write JSON values in any valid context, not just arrays.
Fixes #11360.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.