Skip to content

Commit

Permalink
Clarify XML comments for Utf8Parser.TryParse to reflect case insensit…
Browse files Browse the repository at this point in the history
…ivity (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>
  • Loading branch information
3 people authored and sirntar committed Sep 30, 2024
1 parent 3de9660 commit 68903ee
Showing 1 changed file with 3 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,14 @@ public static partial class Utf8Parser
/// </summary>
/// <param name="source">The Utf8 string to parse</param>
/// <param name="value">Receives the parsed value</param>
/// <param name="bytesConsumed">On a successful parse, receives the length in bytes of the substring that was parsed </param>
/// <param name="standardFormat">Expected format of the Utf8 string</param>
/// <param name="bytesConsumed">On a successful parse, receives the length in bytes of the substring that was parsed.</param>
/// <param name="standardFormat">Expected format of the Utf8 string. Supported formats are <c>'G'</c>, <c>'l'</c>, and <c>default</c>.</param>
/// <returns>
/// true for success. "bytesConsumed" contains the length in bytes of the substring that was parsed.
/// false if the string was not syntactically valid or an overflow or underflow occurred. "bytesConsumed" is set to 0.
/// </returns>
/// <remarks>
/// Formats supported:
/// G (default) True/False
/// l true/false
/// The parsing is case insensitive. The format parameter is validated to ensure it is supported; however, all supported formats are treated identically.
/// </remarks>
/// <exceptions>
/// <cref>System.FormatException</cref> if the format is not valid for this data type.
Expand Down

0 comments on commit 68903ee

Please sign in to comment.