Skip to content

Commit c354bb8

Browse files
Rollup merge of rust-lang#47595 - PieterPenninckx:master, r=shepmaster
Small improvements to the documentation of VecDeque. Some small improvements to the documentation of `VecDeque`.
2 parents 35221d8 + ea814b8 commit c354bb8

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

Diff for: src/liballoc/vec_deque.rs

+8-7
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ impl<T> VecDeque<T> {
906906
}
907907
}
908908

909-
/// Clears the buffer, removing all values.
909+
/// Clears the `VecDeque`, removing all values.
910910
///
911911
/// # Examples
912912
///
@@ -1624,18 +1624,18 @@ impl<T> VecDeque<T> {
16241624
return elem;
16251625
}
16261626

1627-
/// Splits the collection into two at the given index.
1627+
/// Splits the `VecDeque` into two at the given index.
16281628
///
1629-
/// Returns a newly allocated `Self`. `self` contains elements `[0, at)`,
1630-
/// and the returned `Self` contains elements `[at, len)`.
1629+
/// Returns a newly allocated `VecDeque`. `self` contains elements `[0, at)`,
1630+
/// and the returned `VecDeque` contains elements `[at, len)`.
16311631
///
16321632
/// Note that the capacity of `self` does not change.
16331633
///
16341634
/// Element at index 0 is the front of the queue.
16351635
///
16361636
/// # Panics
16371637
///
1638-
/// Panics if `at > len`
1638+
/// Panics if `at > len`.
16391639
///
16401640
/// # Examples
16411641
///
@@ -1815,7 +1815,8 @@ impl<T> VecDeque<T> {
18151815

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

2393-
/// Consumes the list into a front-to-back iterator yielding elements by
2394+
/// Consumes the `VecDeque` into a front-to-back iterator yielding elements by
23942395
/// value.
23952396
fn into_iter(self) -> IntoIter<T> {
23962397
IntoIter { inner: self }

0 commit comments

Comments
 (0)