Skip to content

Commit 2b9543f

Browse files
authored
Apply suggestions from code review
1 parent c69bb5f commit 2b9543f

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

xml/System.Formats.Cbor/CborReader.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
</ReturnValue>
105105
<Docs>
106106
<summary>Gets the conformance mode used by this reader.</summary>
107-
<value>One of the enumeration values that represent the conformance mode used by this reader.</value>
107+
<value>One of the enumeration values that represents the conformance mode used by this reader.</value>
108108
<remarks>To be added.</remarks>
109109
</Docs>
110110
</Member>
@@ -182,7 +182,7 @@
182182
183183
## Remarks
184184
185-
Useful in scenarios where the semantic value decoder needs to be determined at runtime.
185+
Useful in scenarios where the semantic value decoder needs to be determined at run time.
186186
187187
]]></format>
188188
</remarks>
@@ -298,7 +298,7 @@ The next value uses a CBOR encoding that is not valid under the current conforma
298298
299299
## Remarks
300300
301-
The method accepts indefinite length strings, which it will concatenate to a single string.
301+
The method accepts indefinite length strings, which it concatenates to a single string.
302302
303303
]]></format>
304304
</remarks>
@@ -569,7 +569,7 @@ The next value uses a CBOR encoding that is not valid under the current conforma
569569
<Parameter Name="disableConformanceModeChecks" Type="System.Boolean" />
570570
</Parameters>
571571
<Docs>
572-
<param name="disableConformanceModeChecks">Disable conformance mode validation for the read value, equivalent to using <see cref="F:System.Formats.Cbor.CborConformanceMode.Lax" />.</param>
572+
<param name="disableConformanceModeChecks"><see langword="true" /> to disable conformance mode validation for the read value, equivalent to using <see cref="F:System.Formats.Cbor.CborConformanceMode.Lax" />; otherwise, <see langword="false" />.</param>
573573
<summary>Reads the next CBOR data item, returning a <see cref="T:System.ReadOnlyMemory`1" /> view of the encoded value. For indefinite length encodings this includes the break byte.</summary>
574574
<returns>A view of the encoded value as a contiguous region of memory.</returns>
575575
<remarks>To be added.</remarks>
@@ -1044,7 +1044,7 @@ The next value uses a CBOR encoding that is not valid under the current conforma
10441044
## Remarks
10451045
10461046
Map contents are consumed as if they were arrays twice the length of the map's declared size.
1047-
For instance, a map of size `1` containing a key of type int with a value of type string must be consumed by successive calls to <xref:System.Formats.Cbor.CborReader.ReadInt32> and <xref:System.Formats.Cbor.CborReader.ReadTextString>.
1047+
For instance, a map of size `1` containing a key of type `int` with a value of type `string` must be consumed by successive calls to <xref:System.Formats.Cbor.CborReader.ReadInt32> and <xref:System.Formats.Cbor.CborReader.ReadTextString>.
10481048
It is up to the caller to keep track of whether the next value is a key or a value.
10491049
Fundamentally, this is a technical restriction stemming from the fact that CBOR allows keys of arbitrary type, for instance a map can contain keys that are maps themselves.
10501050

xml/System.Formats.Cbor/CborWriter.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,7 @@ The written data is not accepted under the current conformance mode.</exception>
737737
</Parameters>
738738
<Docs>
739739
<param name="value">The value to write</param>
740-
<summary>Writes an value as a signed integer encoding (major types 0,1)</summary>
740+
<summary>Writes a value as a signed integer encoding (major types 0,1)</summary>
741741
<remarks>To be added.</remarks>
742742
<exception cref="T:System.InvalidOperationException">Writing a new value exceeds the definite length of the parent data item.
743743

@@ -1189,7 +1189,7 @@ The written data is not accepted under the current conformance mode.</exception>
11891189
</Parameters>
11901190
<Docs>
11911191
<param name="value">The value to write</param>
1192-
<summary>Writes anvalue as an unsigned integer encoding (major type 0).</summary>
1192+
<summary>Writes a value as an unsigned integer encoding (major type 0).</summary>
11931193
<remarks>To be added.</remarks>
11941194
<exception cref="T:System.InvalidOperationException">Writing a new value exceeds the definite length of the parent data item.
11951195

@@ -1228,7 +1228,7 @@ The written data is not accepted under the current conformance mode.</exception>
12281228
</Parameters>
12291229
<Docs>
12301230
<param name="value">The value to write</param>
1231-
<summary>Writes an value as an unsigned integer encoding (major type 0).</summary>
1231+
<summary>Writes a value as an unsigned integer encoding (major type 0).</summary>
12321232
<remarks>To be added.</remarks>
12331233
<exception cref="T:System.InvalidOperationException">Writing a new value exceeds the definite length of the parent data item.
12341234

xml/System.Globalization/CompareInfo.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2233,7 +2233,7 @@ Use <xref:System.Globalization.CompareInfo.GetSortKeyLength(System.ReadOnlySpan{
22332233

22342234
## Remarks
22352235

2236-
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IndexOf%2A> overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information.
2236+
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IndexOf%2A> overloads that don't take a `matchLength` argument. Call this overload only if you require the match length information.
22372237

22382238
]]></format>
22392239
</remarks>
@@ -3119,7 +3119,7 @@ This method has greater overhead than other <xref:System.Globalization.CompareIn
31193119

31203120
## Remarks
31213121

3122-
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IsPrefix(System.String,System.String,System.Globalization.CompareOptions)> overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information.
3122+
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IsPrefix(System.String,System.String,System.Globalization.CompareOptions)> overloads that don't take a `matchLength` argument. Call this overload only if you require the match length information.
31233123

31243124
]]></format>
31253125
</remarks>
@@ -3589,7 +3589,7 @@ This method has greater overhead than other <xref:System.Globalization.CompareIn
35893589

35903590
## Remarks
35913591

3592-
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IsSuffix(System.String,System.String,System.Globalization.CompareOptions)> overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information.
3592+
This method has greater overhead than other <xref:System.Globalization.CompareInfo.IsSuffix(System.String,System.String,System.Globalization.CompareOptions)> overloads that don't take a `matchLength` argument. Call this overload only if you require the match length information.
35933593

35943594
]]></format>
35953595
</remarks>
@@ -4261,7 +4261,7 @@ This method has greater overhead than other <xref:System.Globalization.CompareIn
42614261

42624262
## Remarks
42634263

4264-
This method has greater overhead than other <xref:System.Globalization.CompareInfo.LastIndexOf%2A> overloads which don't take a `matchLength` argument. Call this overload only if you require the match length information.
4264+
This method has greater overhead than other <xref:System.Globalization.CompareInfo.LastIndexOf%2A> overloads that don't take a `matchLength` argument. Call this overload only if you require the match length information.
42654265

42664266
]]></format>
42674267
</remarks>

0 commit comments

Comments
 (0)