Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 13, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions xml/System.Buffers.Text/Utf8Parser.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,21 +71,16 @@
</Parameters>
<Docs>
<param name="source">The Utf8 string to parse.</param>
<param name="value">When the method returns, contains the value parsed from <paramref name="source" />, if the parsing operation succeeded. </param>
<param name="value">When the method returns, contains the value parsed from <paramref name="source" />, if the parsing operation succeeded.</param>
<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>
<param name="standardFormat">The expected format of the Utf8 string.</param>
<param name="standardFormat">The expected format of the Utf8 string. Supported formats are <c>'G'</c>, <c>'l'</c>, and <c>default</c>.</param>
<summary>Parses a <see cref="T:System.Boolean" /> at the start of a Utf8 string.</summary>
<returns>
<see langword="true" /> for success; <see langword="false" /> if the string was not syntactically valid or an overflow or underflow occurred.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Formats supported:

|Format string|Example expected format|
|--|--|
|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.

]]></format>
</remarks>
Expand Down