Skip to content

Conversation

@PranavSenthilnathan
Copy link
Member

Add documentation for new API introduced in dotnet/runtime#109861

@dotnet-policy-service
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-globalization

@tarekgh tarekgh added this to the Backlog milestone Dec 3, 2024
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@gewarren gewarren marked this pull request as ready for review December 23, 2025 04:16
@gewarren gewarren requested a review from a team as a code owner December 23, 2025 04:16
Copilot AI review requested due to automatic review settings December 23, 2025 04:16
@gewarren gewarren enabled auto-merge (squash) December 23, 2025 04:16
Copy link
Contributor

Copilot AI left a 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 NumericOrdering member documentation to CompareOptions.xml
  • Updates existing CompareOptions member summaries to use consistent phrasing ("A string comparison that..." instead of "Indicates that...")
  • Adds NumericOrdering to parameter documentation lists across CompareInfo and GlobalizationExtensions methods
  • Updates remarks sections to note that NumericOrdering is invalid for indexing methods (like IndexOf, 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants