Clarify XML comments for Utf8Parser.TryParse to reflect case insensitivity #103861
+3
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-policy-service
bot
added
the
community-contribution
joegoldman2
commented
Jun 23, 2024
| /// <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 G and l.</param> |
There was a problem hiding this comment.
A clarification on formats has been added because the current implementation checks the format without using it afterwards.
Should this check be removed?
There was a problem hiding this comment.
This is intentional so the logic isn't blocked from supporting future format specifiers
There was a problem hiding this comment.
Ok. I won't change this validation.
This was referenced Jun 23, 2024
Open
|
Thank you, @joegoldman2. I'd like @tannergooding or @GrabYourPitchforks to review particularly your question that you left about whether the check should be removed. It might be another week or two though. |
src/libraries/System.Private.CoreLib/src/System/Buffers/Text/Utf8Parser/Utf8Parser.Boolean.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Buffers/Text/Utf8Parser/Utf8Parser.Boolean.cs
Outdated
Show resolved
Hide resolved
This was referenced Jul 25, 2024
This was referenced Jul 25, 2024
Closed
| /// <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 G and l. The default value is also accepted.</param> |
There was a problem hiding this comment.
What about:
Suggested change
| /// <param name="standardFormat">Expected format of the Utf8 string. Supported formats are G and l. The default value is also accepted.</param> | |
| /// <param name="standardFormat">Expected format of the Utf8 string. Supported formats are <c>'G'</c>, <c>'l'</c>, and <c>default</c>.</param> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #100659.
I will also update the doc in https://github.com/dotnet/dotnet-api-docs if this PR is accepted.