Skip to content

Commit 82ce59a

Browse files
authored
Fix documentation to clarify culture name usage for case-insensitive comparisons in GeneratedRegexAttribute (#121073)
The documentation appears to be incorrect.
1 parent 530271d commit 82ce59a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/libraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/GeneratedRegexAttribute.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public GeneratedRegexAttribute([StringSyntax(StringSyntaxAttribute.Regex, nameof
4040
/// <summary>Initializes a new instance of the <see cref="GeneratedRegexAttribute"/> with the specified pattern and options.</summary>
4141
/// <param name="pattern">The regular expression pattern to match.</param>
4242
/// <param name="options">A bitwise combination of the enumeration values that modify the regular expression.</param>
43-
/// <param name="cultureName">The name of a culture to be used for case sensitive comparisons. <paramref name="cultureName"/> is not case-sensitive.</param>
43+
/// <param name="cultureName">The name of a culture to be used for case-insensitive comparisons. <paramref name="cultureName"/> is not case-sensitive.</param>
4444
/// <remarks>
4545
/// For a list of predefined culture names on Windows systems, see the Language tag column in the <see href="https://learn.microsoft.com/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c">list of
4646
/// language/region names supported by Windows</see>. Culture names follow the standard defined by <see href="https://tools.ietf.org/html/bcp47">BCP 47</see>. In addition,
@@ -64,7 +64,7 @@ public GeneratedRegexAttribute([StringSyntax(StringSyntaxAttribute.Regex, nameof
6464
/// <param name="pattern">The regular expression pattern to match.</param>
6565
/// <param name="options">A bitwise combination of the enumeration values that modify the regular expression.</param>
6666
/// <param name="matchTimeoutMilliseconds">A time-out interval (milliseconds), or <see cref="Timeout.Infinite"/> to indicate that the method should not time out.</param>
67-
/// <param name="cultureName">The name of a culture to be used for case sensitive comparisons. <paramref name="cultureName"/> is not case-sensitive.</param>
67+
/// <param name="cultureName">The name of a culture to be used for case-insensitive comparisons. <paramref name="cultureName"/> is not case-sensitive.</param>
6868
/// <remarks>
6969
/// For a list of predefined culture names on Windows systems, see the Language tag column in the <see href="https://learn.microsoft.com/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c">list of
7070
/// language/region names supported by Windows</see>. Culture names follow the standard defined by <see href="https://tools.ietf.org/html/bcp47">BCP 47</see>. In addition,
@@ -89,6 +89,6 @@ public GeneratedRegexAttribute([StringSyntax(StringSyntaxAttribute.Regex, nameof
8989
/// <summary>Gets a time-out interval (milliseconds), or <see cref="Timeout.Infinite"/> to indicate that the method should not time out.</summary>
9090
public int MatchTimeoutMilliseconds { get; }
9191

92-
/// <summary>Gets the name of the culture to be used for case sensitive comparisons.</summary>
92+
/// <summary>Gets the name of the culture to be used for case-insensitive comparisons.</summary>
9393
public string CultureName { get; }
9494
}

0 commit comments

Comments
 (0)