about summary refs log tree commit diff
path: root/src/libstd_unicode
diff options
context:
space:
mode:
authorDonnie Bishop <donnie.a.bishop@gmail.com>2017-03-30 16:36:06 -0400
committerDonnie Bishop <donnie.a.bishop@gmail.com>2017-03-30 16:36:06 -0400
commita4a7166fd585802e9644ae9b4aa3e63861d11d3e (patch)
treead896131513105c29c6e0f2381760198a955290b /src/libstd_unicode
parent5d14ccbc96923607f6ab00810817885ee0939486 (diff)
downloadrust-a4a7166fd585802e9644ae9b4aa3e63861d11d3e.tar.gz
rust-a4a7166fd585802e9644ae9b4aa3e63861d11d3e.zip
Modify SplitWhitespace's description
Diffstat (limited to 'src/libstd_unicode')
-rw-r--r--src/libstd_unicode/u_str.rs9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/libstd_unicode/u_str.rs b/src/libstd_unicode/u_str.rs
index 3c02ea82d2a..fd309e822a0 100644
--- a/src/libstd_unicode/u_str.rs
+++ b/src/libstd_unicode/u_str.rs
@@ -17,8 +17,13 @@ use core::char;
 use core::iter::{Filter, FusedIterator};
 use core::str::Split;
 
-/// An iterator over the non-whitespace substrings of a string,
-/// separated by any amount of whitespace.
+/// An iterator over sub-slices of the original string slice.
+///
+/// This struct is created by the [`split_whitespace()`] method on [`str`].
+/// See its documentation for more.
+///
+/// [`split_whitespace()`]: ../../std/primitive.str.html#method.split_whitespace
+/// [`str`]: ../../std/primitive.str.html
 #[stable(feature = "split_whitespace", since = "1.1.0")]
 pub struct SplitWhitespace<'a> {
     inner: Filter<Split<'a, fn(char) -> bool>, fn(&&str) -> bool>,