about summary refs log tree commit diff
path: root/src/libstd_unicode
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2017-03-31 16:48:28 -0400
committerGitHub <noreply@github.com>2017-03-31 16:48:28 -0400
commitc9a9d7acaf74a57ad37cdd883c2f138ea59efc28 (patch)
tree592ca07f98458756a8649ed9b0ac074339d45c60 /src/libstd_unicode
parentc5082fe801d8704a9c33a706daf63d1abfdfca90 (diff)
parent3b396217b5b52cf87769263bf0b842c56471b54f (diff)
downloadrust-c9a9d7acaf74a57ad37cdd883c2f138ea59efc28.tar.gz
rust-c9a9d7acaf74a57ad37cdd883c2f138ea59efc28.zip
Rollup merge of #40935 - donniebishop:str_boilerplate_docs, r=steveklabnik
Modify str Structs descriptions

References #29375. Modified descriptions of multiple structs to be more in line with structs found under [`std::iter`](https://doc.rust-lang.org/std/iter/#structs), such as [`Chain`](https://doc.rust-lang.org/std/iter/struct.Chain.html) and [`Enumerate`](https://doc.rust-lang.org/std/iter/struct.Enumerate.html)
Diffstat (limited to 'src/libstd_unicode')
-rw-r--r--src/libstd_unicode/u_str.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libstd_unicode/u_str.rs b/src/libstd_unicode/u_str.rs
index 3c02ea82d2a..770b67acd49 100644
--- a/src/libstd_unicode/u_str.rs
+++ b/src/libstd_unicode/u_str.rs
@@ -19,6 +19,12 @@ use core::str::Split;
 
 /// An iterator over the non-whitespace substrings of a string,
 /// separated by any amount of whitespace.
+///
+/// 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>,