Skip to content

Commit 6b589c4

Browse files
authored
Change wording
1 parent e79c64e commit 6b589c4

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

Diff for: core/src/str/mod.rs

+6-7
Original file line numberDiff line numberDiff line change
@@ -1157,14 +1157,13 @@ impl str {
11571157
///
11581158
/// Returns `false` if it does not.
11591159
///
1160-
/// The [pattern] can be a `&str`, [`char`], a slice of [`char`]s, or a
1161-
/// function or closure that determines if a character matches.
1160+
/// The [pattern] can be a `&str`, in which case this function will return true if
1161+
/// the `&str` is a prefix of this string slice.
11621162
///
1163-
/// Note that there is a footgun to this method when using a slice of [`char`]s.
1164-
/// Some users may expect that a slice of chars will behave similarly to a `&str` with this method.
1165-
/// That is not currently the case. When you pass a slice of [`char`]s to this method, it will return true
1166-
/// if any of the [`char`]s in the slice is the first [`char`] of this string slice. It does not work for
1167-
/// sequentially comparing a slice of [`char`]s to a string slice. See the second example below.
1163+
/// The [pattern] can also be a [`char`], a slice of [`char`]s, or a
1164+
/// function or closure that determines if a character matches.
1165+
/// These will only be checked against the first character of this string slice.
1166+
/// Look at the second example below regarding behavior for slices of [`char`]s.
11681167
///
11691168
/// [`char`]: prim@char
11701169
/// [pattern]: self::pattern

0 commit comments

Comments
 (0)