Skip to content

Commit e796c47

Browse files
authored
Clarify XML comments for Utf8Parser.TryParse to reflect case insensitivity
1 parent 9a5badc commit e796c47

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

xml/System.Buffers.Text/Utf8Parser.xml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,16 @@
7171
</Parameters>
7272
<Docs>
7373
<param name="source">The Utf8 string to parse.</param>
74-
<param name="value">When the method returns, contains the value parsed from <paramref name="source" />, if the parsing operation succeeded. </param>
74+
<param name="value">When the method returns, contains the value parsed from <paramref name="source" />, if the parsing operation succeeded.</param>
7575
<param name="bytesConsumed">If the parsing operation was successful, contains the length in bytes of the parsed substring when the method returns. If the method fails, <paramref name="bytesConsumed" /> is set to 0.</param>
76-
<param name="standardFormat">The expected format of the Utf8 string.</param>
76+
<param name="standardFormat">The expected format of the Utf8 string. Supported formats are <c>'G'</c>, <c>'l'</c>, and <c>default</c>.</param>
7777
<summary>Parses a <see cref="T:System.Boolean" /> at the start of a Utf8 string.</summary>
7878
<returns>
7979
<see langword="true" /> for success; <see langword="false" /> if the string was not syntactically valid or an overflow or underflow occurred.</returns>
8080
<remarks>
8181
<format type="text/markdown"><![CDATA[
8282
83-
Formats supported:
84-
85-
|Format string|Example expected format|
86-
|--|--|
87-
|G (default)|True/False|
88-
|l|true/false|
83+
The parsing is case insensitive. The format parameter is validated to ensure it is supported; however, all supported formats are treated identically.
8984
9085
]]></format>
9186
</remarks>

0 commit comments

Comments
 (0)