Fixed broken xref in Utf8JSonWriter #2422
Conversation
| Since this type is a ref struct, it does not directly support async. However, it does provide support for reentrancy to write partial data and to continue writing in chunks. | ||
| To be able to format the output with indentation and white space OR to skip validation, create an instance of <xref:System.Text.Json.JsonWriterState> and pass that in to the writer. | ||
|
|
||
| To be able to format the output with indentation and white space OR to skip validation, create an instance of <xref:System.Text.Json.JsonWriterOptions> and pass it in to the writer. |
There was a problem hiding this comment.
This isn't the only change that would need to be made. The type is no longer a ref struct, and a few APIs/comments changed.
There was a problem hiding this comment.
We should probably re-run the tool to grab comments from source similar to what @carlossanlop had done previously (#2360)
There was a problem hiding this comment.
Hey team, I re-ran the tool and opened a new PR with the most up to date API versions: #2471
There was a problem hiding this comment.
That PR doesn't contain this change so do we need to run the tool replacing existing content too?
There was a problem hiding this comment.
I think this is the case of "merge-conflict (case 2 below)" which means we need to manually update the contents to match the new content.
Here are the cases:
- Source contains comments, docs repo doesn't - @carlossanlop tool captures the diff and adds the content.
- Source contains comments, docs contains comments - usually do nothing (the tool ignores this), docs are the source of truth (unless an update was required/API change/etc - then manual updates needed).
- Source doesn't contain comments, docs repo contains comments - do nothing, we have the docs already.
- Source doesn't contain comments, docs repo doesn't contain comments - dev/docs team should add comments to this repo.
There was a problem hiding this comment.
LGTM but left a comment re. the source comments for @ahsonkhan and @carlossanlop
| Since this type is a ref struct, it does not directly support async. However, it does provide support for reentrancy to write partial data and to continue writing in chunks. | ||
| To be able to format the output with indentation and white space OR to skip validation, create an instance of <xref:System.Text.Json.JsonWriterState> and pass that in to the writer. | ||
|
|
||
| To be able to format the output with indentation and white space OR to skip validation, create an instance of <xref:System.Text.Json.JsonWriterOptions> and pass it in to the writer. |
There was a problem hiding this comment.
That PR doesn't contain this change so do we need to run the tool replacing existing content too?
Fixed broken xref in Utf8JSonWriter