nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-01-25 14:13:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small improvements to the documentation of VecDeque.

Browse Source
This commit is contained in:
Pieter Penninckx 2018-01-19 16:51:46 +01:00
parent 10333dde82
commit 81e6840ff4
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/liballoc/vec_deque.rs
View File

@ -906,7 +906,7 @@ impl<T> VecDeque<T> {
} }
} }
/// Clears the buffer, removing all values. /// Clears the `VecDeque`, removing all values.
/// ///
/// # Examples /// # Examples
/// ///
@ -1624,10 +1624,10 @@ impl<T> VecDeque<T> {
return elem; 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)`, /// Returns a newly allocated `VecDeque`. `self` contains elements `[0, at)`,
/// and the returned `Self` contains elements `[at, len)`. /// and the returned `VecDeque` contains elements `[at, len)`.
/// ///
/// Note that the capacity of `self` does not change. /// Note that the capacity of `self` does not change.
/// ///
@ -1635,7 +1635,7 @@ impl<T> VecDeque<T> {
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if `at > len` /// Panics if `at` is out of bounds.
/// ///
/// # Examples /// # Examples
/// ///
@ -1815,7 +1815,8 @@ impl<T> VecDeque<T> {
impl<T: Clone> VecDeque<T> { impl<T: Clone> VecDeque<T> {
/// Modifies the `VecDeque` in-place so that `len()` is equal to new_len, /// 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 /// # Examples
/// ///
@ -2390,7 +2391,7 @@ impl<T> IntoIterator for VecDeque<T> {
type Item = T; type Item = T;
type IntoIter = IntoIter<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. /// value.
fn into_iter(self) -> IntoIter<T> { fn into_iter(self) -> IntoIter<T> {
IntoIter { inner: self } IntoIter { inner: self }