System.Globalization.CompareOptions update

[daverayment]

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 CompareOptions enum values affect string comparisons, for all four supported languages.
• Updated StringSort code example, which now uses more modern and consistent .NET conventions, and includes a note about changes brought about in .NET 5 (where StringSort and None are now equivalent by default).
• Added StringSort F# example.

Additional Globalization documentation update in main dotnet/docs repo PR: 41661

Fixes #41052

[daverayment]

@dotnet-policy-service agree

[learn-build-service-prod]

Learn Build status updates of commit a5e9fb8:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Globalization/CompareOptions.xml	⚠️Warning	View	Details
snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CompareOptions.StringSort/CPP/compareoptions_stringsort.cpp	✅Succeeded	View
snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CompareOptions.Values/CPP/compareoptions_values.cpp	✅Succeeded	View
snippets/csharp/System.Globalization/CompareOptions/Overview/compareoptions_stringsort.cs	✅Succeeded	View
snippets/csharp/System.Globalization/CompareOptions/Overview/compareoptions_values.cs	✅Succeeded	View
snippets/fsharp/System.Globalization/compareoptions_stringsort.fs	✅Succeeded	View
snippets/fsharp/System.Globalization/compareoptions_values.fs	✅Succeeded	View
snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.CompareOptions.StringSort/VB/compareoptions_stringsort.vb	✅Succeeded	View
snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.CompareOptions.Values/VB/compareoptions_values.vb	✅Succeeded	View

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