Skip to content

Commit

Permalink
Rollup merge of rust-lang#47595 - PieterPenninckx:master, r=shepmaster
Browse files Browse the repository at this point in the history
Small improvements to the documentation of VecDeque.

Some small improvements to the documentation of `VecDeque`.
  • Loading branch information
GuillaumeGomez authored Jan 21, 2018
2 parents 35221d8 + ea814b8 commit c354bb8
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/liballoc/vec_deque.rs
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ impl<T> VecDeque<T> {
}
}

/// Clears the buffer, removing all values.
/// Clears the `VecDeque`, removing all values.
///
/// # Examples
///
Expand Down Expand Up @@ -1624,18 +1624,18 @@ impl<T> VecDeque<T> {
return elem;
}

/// Splits the collection into two at the given index.
/// Splits the `VecDeque` into two at the given index.
///
/// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
/// and the returned `Self` contains elements `[at, len)`.
/// Returns a newly allocated `VecDeque`. `self` contains elements `[0, at)`,
/// and the returned `VecDeque` contains elements `[at, len)`.
///
/// Note that the capacity of `self` does not change.
///
/// Element at index 0 is the front of the queue.
///
/// # Panics
///
/// Panics if `at > len`
/// Panics if `at > len`.
///
/// # Examples
///
Expand Down Expand Up @@ -1815,7 +1815,8 @@ impl<T> VecDeque<T> {

impl<T: Clone> VecDeque<T> {
/// Modifies the `VecDeque` in-place so that `len()` is equal to new_len,
/// either by removing excess elements or by appending clones of `value` to the back.
/// either by removing excess elements from the back or by appending clones of `value`
/// to the back.
///
/// # Examples
///
Expand Down Expand Up @@ -2390,7 +2391,7 @@ impl<T> IntoIterator for VecDeque<T> {
type Item = T;
type IntoIter = IntoIter<T>;

/// Consumes the list into a front-to-back iterator yielding elements by
/// Consumes the `VecDeque` into a front-to-back iterator yielding elements by
/// value.
fn into_iter(self) -> IntoIter<T> {
IntoIter { inner: self }
Expand Down

0 comments on commit c354bb8

Please sign in to comment.