Add documentation for CompareOptions.NumericOrdering#10721
Merged
Conversation
ghost
added
the
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-globalization |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
gewarren
approved these changes
Dec 23, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new CompareOptions.NumericOrdering API introduced in dotnet/runtime#109861. The changes update several XML documentation files to include references to the new option and clarify when it's valid or invalid for use.
- Adds the
NumericOrderingmember documentation toCompareOptions.xml - Updates existing
CompareOptionsmember summaries to use consistent phrasing ("A string comparison that..." instead of "Indicates that...") - Adds
NumericOrderingto parameter documentation lists acrossCompareInfoandGlobalizationExtensionsmethods - Updates remarks sections to note that
NumericOrderingis invalid for indexing methods (likeIndexOf,IsPrefix,IsSuffix,LastIndexOf)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| xml/System.Globalization/CompareOptions.xml | Adds NumericOrdering member documentation; updates existing member summaries to use consistent style; improves remarks section with present tense |
| xml/System.Globalization/GlobalizationExtensions.xml | Adds NumericOrdering to the GetStringComparer options parameter documentation |
| xml/System.Globalization/CompareInfo.xml | Adds NumericOrdering to Compare, GetSortKey parameter documentation; updates remarks to note NumericOrdering is invalid for indexing methods |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
Add documentation for new API introduced in dotnet/runtime#109861