Skip to content

Commit 95e45a9

Browse files
authored
Refactor remarks sections for JSON serializer options
1 parent 4f7bf31 commit 95e45a9

File tree

1 file changed

+15
-34
lines changed

1 file changed

+15
-34
lines changed

xml/System.Text.Json/JsonSerializerDefaults.xml

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,7 @@
5050
<para>General-purpose option values. These are the same settings that are applied if a <see cref="T:System.Text.Json.JsonSerializerDefaults" /> member isn't specified.</para>
5151
<para>For information about the default property values that are applied, see <see href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializeroptions#properties">JsonSerializerOptions properties</see>.</para>
5252
</summary>
53-
<remarks>
54-
<format type="text/markdown"><![CDATA[
55-
56-
## Remarks
57-
58-
This option implies that property names are treated as case-sensitive and that "PascalCase" name formatting should be employed.
59-
60-
]]></format>
61-
</remarks>
53+
<remarks>This option implies that property names are treated as case-sensitive and that "PascalCase" name formatting should be employed.</remarks>
6254
</Docs>
6355
</Member>
6456
<Member MemberName="Strict">
@@ -82,20 +74,14 @@ This option implies that property names are treated as case-sensitive and that "
8274
<summary>
8375
<para>Option values appropriate for strict JSON parsing.</para>
8476
<para>This member implies that:</para>
85-
<para>- Unmapped JSON properties are disallowed.</para>
86-
<para>- Duplicate JSON properties aren't allowed.</para>
87-
<para>- Nullable reference type annotations are respected.</para>
88-
<para>- Required constructor parameters are respected.</para>
77+
<list type="bullet">
78+
<item>Unmapped JSON properties aren't allowed.</item>
79+
<item>Duplicate JSON properties aren't allowed.</item>
80+
<item>Nullable reference type annotations are respected.</item>
81+
<item>Required constructor parameters are respected.</item>
82+
</list>
8983
</summary>
90-
<remarks>
91-
<format type="text/markdown"><![CDATA[
92-
93-
## Remarks
94-
95-
This option configures stricter deserialization behavior that rejects unmapped properties, duplicate properties, and enforces both nullable annotations and required constructor parameters.
96-
97-
]]></format>
98-
</remarks>
84+
<remarks>This option configures stricter deserialization behavior that rejects unmapped or duplicate properties, and enforces both nullable annotations and required constructor parameters.</remarks>
9985
</Docs>
10086
</Member>
10187
<Member MemberName="Web">
@@ -124,19 +110,14 @@ This option configures stricter deserialization behavior that rejects unmapped p
124110
<summary>
125111
<para>Option values appropriate to Web-based scenarios.</para>
126112
<para>This member implies that:</para>
127-
<para>- Property names are treated as case-insensitive.</para>
128-
<para>- "camelCase" name formatting should be employed.</para>
129-
<para>- Quoted numbers (JSON strings for number properties) are allowed.</para>
113+
<list type="bullet">
114+
<item>Integers must be encoded as small as possible.</item>
115+
<item>Property names are treated as case-insensitive.</item>
116+
<item>"camelCase" name formatting should be employed.</item>
117+
<item>Quoted numbers (JSON strings for number properties) are allowed.</item>
118+
</list>
130119
</summary>
131-
<remarks>
132-
<format type="text/markdown"><![CDATA[
133-
134-
## Remarks
135-
136-
This option implies that property names are treated as case-insensitive and that "camelCase" name formatting should be employed.
137-
138-
]]></format>
139-
</remarks>
120+
<remarks>This option implies that property names are treated as case-insensitive and that "camelCase" name formatting should be employed.</remarks>
140121
</Docs>
141122
</Member>
142123
</Members>

0 commit comments

Comments
 (0)