-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add documentation for CompareOptions.NumericOrdering #10721
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
base: main
Are you sure you want to change the base?
Add documentation for CompareOptions.NumericOrdering #10721
Conversation
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
Add documentation for new API introduced in dotnet/runtime#109861