Skip to content

Commit

Permalink
Rollup merge of rust-lang#40949 - stjepang:fix-vecdeque-docs, r=frewsxcv
Browse files Browse the repository at this point in the history
Improve some docs for VecDeque

r? @GuillaumeGomez
  • Loading branch information
frewsxcv authored Apr 3, 2017
2 parents 810eb03 + 1e2a61d commit f7358ec
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/libcollections/vec_deque.rs
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ impl<T> VecDeque<T> {
}
}

/// Shortens a `VecDeque`, dropping excess elements from the back.
/// Shortens the `VecDeque`, dropping excess elements from the back.
///
/// If `len` is greater than the `VecDeque`'s current length, this has no
/// effect.
Expand Down Expand Up @@ -941,7 +941,7 @@ impl<T> VecDeque<T> {
a.contains(x) || b.contains(x)
}

/// Provides a reference to the front element, or `None` if the sequence is
/// Provides a reference to the front element, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -966,7 +966,7 @@ impl<T> VecDeque<T> {
}

/// Provides a mutable reference to the front element, or `None` if the
/// sequence is empty.
/// `VecDeque` is empty.
///
/// # Examples
///
Expand All @@ -993,7 +993,7 @@ impl<T> VecDeque<T> {
}
}

/// Provides a reference to the back element, or `None` if the sequence is
/// Provides a reference to the back element, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -1018,7 +1018,7 @@ impl<T> VecDeque<T> {
}

/// Provides a mutable reference to the back element, or `None` if the
/// sequence is empty.
/// `VecDeque` is empty.
///
/// # Examples
///
Expand Down Expand Up @@ -1046,7 +1046,7 @@ impl<T> VecDeque<T> {
}
}

/// Removes the first element and returns it, or `None` if the sequence is
/// Removes the first element and returns it, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -1073,7 +1073,7 @@ impl<T> VecDeque<T> {
}
}

/// Inserts an element first in the sequence.
/// Prepends an element to the `VecDeque`.
///
/// # Examples
///
Expand All @@ -1096,7 +1096,7 @@ impl<T> VecDeque<T> {
}
}

/// Appends an element to the back of a buffer
/// Appends an element to the back of the `VecDeque`.
///
/// # Examples
///
Expand All @@ -1117,7 +1117,7 @@ impl<T> VecDeque<T> {
unsafe { self.buffer_write(head, value) }
}

/// Removes the last element from a buffer and returns it, or `None` if
/// Removes the last element from the `VecDeque` and returns it, or `None` if
/// it is empty.
///
/// # Examples
Expand Down

0 comments on commit f7358ec

Please sign in to comment.