System.Globalization.CompareOptions update
Summary
- New remarks section describing the change in .NET 5 to use the ICU library, which changes the default sort order and affects the behaviour of comparing against ligature characters.
- Rewrote descriptions for each of the options, simplifying language and improving consistency.
- New code example which details how each of the
CompareOptionsenum values affect string comparisons, for all four supported languages. - Updated
StringSortcode example, which now uses more modern and consistent .NET conventions, and includes a note about changes brought about in .NET 5 (whereStringSortandNoneare now equivalent by default). - Added
StringSortF# example.
Additional Globalization documentation update in main dotnet/docs repo PR: 41661
Fixes #41052
@dotnet-policy-service agree
Learn Build status updates of commit a5e9fb8:
:warning: Validation status: warnings
xml/System.Globalization/CompareOptions.xml
- Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Tagging subscribers to this area: @dotnet/area-system-globalization
@daverayment Thanks for submitting the PR! Would you be able to fix the errors here: https://github.com/dotnet/dotnet-api-docs/actions/runs/9810025035/job/27168649470?pr=10087? I don't believe your changes caused them, but since we're already modifying the code, it would be great to address them.
Also, did you run the updated samples to ensure everything works correctly?
@daverayment would you have a chance to address the minor remaining feedback so we can proceed merging this one?
@tarekgh Thank you for the review.
I'm sorry, I don't have time to revisit this at the moment. I don't know how to add the parent project, so perhaps you could help?
Learn Build status updates of commit a5e9fb8:
:warning: Validation status: warnings
xml/System.Globalization/CompareOptions.xml
- Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@gewarren do you know who can help guide how we can fix the issues with this PR?
- https://github.com/dotnet/dotnet-api-docs/pull/10087#user-content-10ffc2784250d1cb2b96fc8f9f05481a-8e61ecc0
- https://github.com/dotnet/dotnet-api-docs/actions/runs/14208294553/job/39810584209?pr=10087
CC @BillWagner if can help too.
Learn Build status updates of commit 7ff5368:
:warning: Validation status: warnings
xml/System.Globalization/CompareOptions.xml
- Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead. - Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Learn Build status updates of commit 448db5d:
:warning: Validation status: warnings
xml/System.Globalization/CompareOptions.xml
- Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead. - Line 0, Column 0: [Warning: invalid-code]
It looks like your code snippet was not rendered. Try range instead.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel