From 47e81ed3ab2f10e6bcad45fe1b93b6d8fde10aa0 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Tue, 9 Feb 2016 12:02:55 -0500 Subject: [PATCH] Improve docs for Drain on String This is the last bit of String docs needed to Close #29376 --- src/libcollections/string.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs index 7f6def68320..2366432e6a2 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