Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify XML comments for Utf8Parser.TryParse to reflect case insensitivity #103861

Merged
merged 9 commits into from
Sep 11, 2024
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>
joegoldman2 marked this conversation as resolved.
Show resolved Hide resolved
/// <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
Loading