Skip to content

Commit 68903ee

Browse files
joegoldman2joegoldman2tannergooding
authored andcommitted
Clarify XML comments for Utf8Parser.TryParse to reflect case insensitivity (dotnet#103861)
* Clarify XML comments for Utf8Parser.TryParse to reflect case insensitivity * Clarify doc * Update doc * Update src/libraries/System.Private.CoreLib/src/System/Buffers/Text/Utf8Parser/Utf8Parser.Boolean.cs Co-authored-by: Tanner Gooding <tagoo@outlook.com> * Update src/libraries/System.Private.CoreLib/src/System/Buffers/Text/Utf8Parser/Utf8Parser.Boolean.cs --------- Co-authored-by: joegoldman2 <147369450+joegoldman@users.noreply.github.com> Co-authored-by: Tanner Gooding <tagoo@outlook.com>
1 parent 3de9660 commit 68903ee

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

src/libraries/System.Private.CoreLib/src/System/Buffers/Text/Utf8Parser/Utf8Parser.Boolean.cs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,14 @@ public static partial class Utf8Parser
1212
/// </summary>
1313
/// <param name="source">The Utf8 string to parse</param>
1414
/// <param name="value">Receives the parsed value</param>
15-
/// <param name="bytesConsumed">On a successful parse, receives the length in bytes of the substring that was parsed </param>
16-
/// <param name="standardFormat">Expected format of the Utf8 string</param>
15+
/// <param name="bytesConsumed">On a successful parse, receives the length in bytes of the substring that was parsed.</param>
16+
/// <param name="standardFormat">Expected format of the Utf8 string. Supported formats are <c>'G'</c>, <c>'l'</c>, and <c>default</c>.</param>
1717
/// <returns>
1818
/// true for success. "bytesConsumed" contains the length in bytes of the substring that was parsed.
1919
/// false if the string was not syntactically valid or an overflow or underflow occurred. "bytesConsumed" is set to 0.
2020
/// </returns>
2121
/// <remarks>
22-
/// Formats supported:
23-
/// G (default) True/False
24-
/// l true/false
22+
/// The parsing is case insensitive. The format parameter is validated to ensure it is supported; however, all supported formats are treated identically.
2523
/// </remarks>
2624
/// <exceptions>
2725
/// <cref>System.FormatException</cref> if the format is not valid for this data type.

0 commit comments

Comments
 (0)