Skip to content

Commit

Permalink
Improve docs for Drain on String
Browse files Browse the repository at this point in the history
This is the last bit of String docs needed to

Close #29376
  • Loading branch information
steveklabnik committed Feb 9, 2016
1 parent 6630a08 commit 47e81ed
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/libcollections/string.rs
Expand Up @@ -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
Expand Down

0 comments on commit 47e81ed

Please sign in to comment.