about summary refs log tree commit diff
path: root/src/libcollections
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2016-02-09 16:58:59 -0500
committerSteve Klabnik <steve@steveklabnik.com>2016-02-09 16:58:59 -0500
commita1a0edc690a3395ceebadda2812fb3e1d7bf3712 (patch)
tree08cc5f05a0b108ba588a7b0204181d854f5a5775 /src/libcollections
parent6571ae28a81e899aeb3eae81ee26c3cf31fddd1c (diff)
parent47e81ed3ab2f10e6bcad45fe1b93b6d8fde10aa0 (diff)
downloadrust-a1a0edc690a3395ceebadda2812fb3e1d7bf3712.tar.gz
rust-a1a0edc690a3395ceebadda2812fb3e1d7bf3712.zip
Rollup merge of #31515 - steveklabnik:doc_drain, r=alexcrichton
This is the last bit of String docs needed to

Close #29376
Diffstat (limited to 'src/libcollections')
-rw-r--r--src/libcollections/string.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs
index 7137fdde97e..62ae7938e15 100644
--- a/src/libcollections/string.rs
+++ b/src/libcollections/string.rs
@@ -1842,6 +1842,12 @@ impl fmt::Write for String {
 }
 
 /// A draining iterator for `String`.
+///
+/// This struct is created by the [`drain()`] method on [`String`]. See its
+/// documentation for more.
+///
+/// [`drain()`]: struct.String.html#method.drain
+/// [`String`]: struct.String.html
 #[stable(feature = "drain", since = "1.6.0")]
 pub struct Drain<'a> {
     /// Will be used as &'a mut String in the destructor