Skip to content

Commit 47e81ed

Browse files
committed
Improve docs for Drain on String
This is the last bit of String docs needed to Close #29376
1 parent 6630a08 commit 47e81ed

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/libcollections/string.rs

+6
Original file line numberDiff line numberDiff line change
@@ -1842,6 +1842,12 @@ impl fmt::Write for String {
18421842
}
18431843

18441844
/// A draining iterator for `String`.
1845+
///
1846+
/// This struct is created by the [`drain()`] method on [`String`]. See its
1847+
/// documentation for more.
1848+
///
1849+
/// [`drain()`]: struct.String.html#method.drain
1850+
/// [`String`]: struct.String.html
18451851
#[stable(feature = "drain", since = "1.6.0")]
18461852
pub struct Drain<'a> {
18471853
/// Will be used as &'a mut String in the destructor

0 commit comments

Comments
 (0)