about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2015-09-24 02:39:02 +0000
committerbors <bors@rust-lang.org>2015-09-24 02:39:02 +0000
commit8fe79bdfdacb2f5914971bd1a0b63b9577afbf6a (patch)
treec88db9257618e778ac4a7d19366b7a6e9a0b4130
parentf0666b45dd9adef751340e86badbef4daedb2dc2 (diff)
parent30fbf44fbc3d844c3e609bffa239151d5efcbccd (diff)
downloadrust-8fe79bdfdacb2f5914971bd1a0b63b9577afbf6a.tar.gz
rust-8fe79bdfdacb2f5914971bd1a0b63b9577afbf6a.zip
Auto merge of #28607 - remram44:doc-fix-str-pattern, r=alexcrichton
Reported by Moonlightning on #rust
> 17:13 EDT < Moonlightning> I think I found a bug in the str::matches() documentation. Was it copied from str::split()? :p
> 17:13 EDT < Moonlightning> Because it says “The pattern can be a simple `&str`, `char`, or a closure that determines the split.”

I changed "determines the split" to "determines if a character matches".

It's not super clear, "determines the split" is not super clear to begin with, maybe this can be made better? On the other hand following the link to Pattern provides enough details.
-rw-r--r--src/libcollections/str.rs21
1 files changed, 9 insertions, 12 deletions
diff --git a/src/libcollections/str.rs b/src/libcollections/str.rs
index 23c21a732b5..2f74ab5026e 100644
--- a/src/libcollections/str.rs
+++ b/src/libcollections/str.rs
@@ -715,8 +715,7 @@ impl str {
     /// Returns `None` if it doesn't exist.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines the
-    /// split.
+    /// determines if a character matches.
     ///
     /// # Examples
     ///
@@ -760,7 +759,7 @@ impl str {
     /// Returns `None` if it doesn't exist.
     ///
     /// The pattern can be a simple `&str`, `char`,
-    /// or a closure that determines the split.
+    /// or a closure that determines if a character matches.
     ///
     /// # Examples
     ///
@@ -1096,7 +1095,7 @@ impl str {
     /// An iterator over the matches of a pattern within `self`.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines the split.
+    /// determines if a character matches.
     /// Additional libraries might provide more complex patterns like
     /// regular expressions.
     ///
@@ -1129,7 +1128,7 @@ impl str {
     /// reverse order.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines the split.
+    /// determines if a character matches.
     /// Additional libraries might provide more complex patterns like
     /// regular expressions.
     ///
@@ -1166,8 +1165,7 @@ impl str {
     /// match are returned.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines
-    /// the split.
+    /// determines if a character matches.
     /// Additional libraries might provide more complex patterns like
     /// regular expressions.
     ///
@@ -1214,8 +1212,7 @@ impl str {
     /// match are returned.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines
-    /// the split.
+    /// determines if a character matches.
     /// Additional libraries might provide more complex patterns like
     /// regular expressions.
     ///
@@ -1296,7 +1293,7 @@ impl str {
     /// repeatedly removed.
     ///
     /// The pattern can be a simple `char`, or a closure that determines
-    /// the split.
+    /// if a character matches.
     ///
     /// # Examples
     ///
@@ -1326,7 +1323,7 @@ impl str {
     /// repeatedly removed.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines the split.
+    /// determines if a character matches.
     ///
     /// # Examples
     ///
@@ -1346,7 +1343,7 @@ impl str {
     /// repeatedly removed.
     ///
     /// The pattern can be a simple `&str`, `char`, or a closure that
-    /// determines the split.
+    /// determines if a character matches.
     ///
     /// # Examples
     ///