Clarify String.Contains #4250
Clarify String.Contains #4250
Conversation
| <returns> | ||
| <see langword="true" /> if the <paramref name="value" /> parameter occurs within this string; otherwise, <see langword="false" />.</returns> | ||
| <remarks>To be added.</remarks> | ||
| <remarks> |
There was a problem hiding this comment.
My understanding is that remarks don't show in intellisense. If we want this to show up in VS, we should move this change up into the summary. I'm happy with the text itself though :)
There was a problem hiding this comment.
Just copying Contains (string value). @BillWagner ?
There was a problem hiding this comment.
@BillWagner could you help with that question?
| This method performs an ordinal (case-sensitive and culture-insensitive) comparison. The search begins at the first character position of this string and continues through the last character position. | ||
|
|
||
| To determine whether a string contains a specified substring by using something other than ordinal comparison (such as culture-sensitive comparison, or ordinal case-insensitive comparison), you can create a custom method. The following example illustrates one such approach. It defines a <xref:System.String> extension method that includes a <xref:System.StringComparison> parameter and indicates whether a string contains a substring when using the specified form of string comparison. | ||
| **.NET Framework only**: To determine whether a string contains a specified substring by using something other than ordinal comparison (such as culture-sensitive comparison, or ordinal case-insensitive comparison), you can create a custom method. The following example illustrates one such approach. It defines a <xref:System.String> extension method that includes a <xref:System.StringComparison> parameter and indicates whether a string contains a substring when using the specified form of string comparison. |
There was a problem hiding this comment.
Does writing .NET Framework only at the beginning make it seem like the ability exists only in .NET Framework and not in .NET core(when it actually does)?
There was a problem hiding this comment.
Not sure, I just copied this pattern. I defer to docs folks.
|
@pgovind since the questions above relate to the existing doc, perhaps it would make sense to merge this as is? |
Agreed. Approved |
Summary
Clarify that
String.Contains(char)uses Ordinal comparison. (This may be assumed to most, but it clarifies when one needs to useString.Contains(char, StringComparison).Note that the extension method version of
String.Contains(string, StringComparison)is only relevant to .NET Framework. The method is included in .NET Core.