Document behavior of the newly added System.Text.Json snake case and kebab case policies #36652
Labels
area-System.Text.Json
doc-idea
Indicates issues that are suggestions for new topics [org][type][category]
dotnet-fundamentals/svc
Pri1
High priority, do before Pri2 and Pri3
📌 seQUESTered
Identifies that an issue has been imported into Quest.
.NET 8 includes built-in support for snake_case and kebab-case naming policies. Even though we recently updated the implementation to more closely match the semantics of the equivalent Json.NET feature, we intentionally deviated in certain cases where consensus is that the Json.NET implementation is flawed.
This divergence still has the potential of breaking users that are migrating from Json.NET to System.Text.Json, so we should try to document it. A good starting point is this commit whose test diffs highlight where exactly different outputs should be expected.
In addition to the above, we should consider documenting the fact that the naming policies (both old and new) don't support letters that are surrogate pairs. See dotnet/runtime#90352 for more details.
cc @gewarren @IEvangelist
Associated WorkItem - 156741
The text was updated successfully, but these errors were encountered: