Skip to content

Commit b9f51e6

Browse files
authored
Rollup merge of rust-lang#40949 - stjepang:fix-vecdeque-docs, r=frewsxcv
Improve some docs for VecDeque r? @GuillaumeGomez
2 parents 14a7dd4 + 1e2a61d commit b9f51e6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/libcollections/vec_deque.rs

+9-9
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ impl<T> VecDeque<T> {
635635
}
636636
}
637637

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

944-
/// Provides a reference to the front element, or `None` if the sequence is
944+
/// Provides a reference to the front element, or `None` if the `VecDeque` is
945945
/// empty.
946946
///
947947
/// # Examples
@@ -966,7 +966,7 @@ impl<T> VecDeque<T> {
966966
}
967967

968968
/// Provides a mutable reference to the front element, or `None` if the
969-
/// sequence is empty.
969+
/// `VecDeque` is empty.
970970
///
971971
/// # Examples
972972
///
@@ -993,7 +993,7 @@ impl<T> VecDeque<T> {
993993
}
994994
}
995995

996-
/// Provides a reference to the back element, or `None` if the sequence is
996+
/// Provides a reference to the back element, or `None` if the `VecDeque` is
997997
/// empty.
998998
///
999999
/// # Examples
@@ -1018,7 +1018,7 @@ impl<T> VecDeque<T> {
10181018
}
10191019

10201020
/// Provides a mutable reference to the back element, or `None` if the
1021-
/// sequence is empty.
1021+
/// `VecDeque` is empty.
10221022
///
10231023
/// # Examples
10241024
///
@@ -1046,7 +1046,7 @@ impl<T> VecDeque<T> {
10461046
}
10471047
}
10481048

1049-
/// Removes the first element and returns it, or `None` if the sequence is
1049+
/// Removes the first element and returns it, or `None` if the `VecDeque` is
10501050
/// empty.
10511051
///
10521052
/// # Examples
@@ -1073,7 +1073,7 @@ impl<T> VecDeque<T> {
10731073
}
10741074
}
10751075

1076-
/// Inserts an element first in the sequence.
1076+
/// Prepends an element to the `VecDeque`.
10771077
///
10781078
/// # Examples
10791079
///
@@ -1096,7 +1096,7 @@ impl<T> VecDeque<T> {
10961096
}
10971097
}
10981098

1099-
/// Appends an element to the back of a buffer
1099+
/// Appends an element to the back of the `VecDeque`.
11001100
///
11011101
/// # Examples
11021102
///
@@ -1117,7 +1117,7 @@ impl<T> VecDeque<T> {
11171117
unsafe { self.buffer_write(head, value) }
11181118
}
11191119

1120-
/// Removes the last element from a buffer and returns it, or `None` if
1120+
/// Removes the last element from the `VecDeque` and returns it, or `None` if
11211121
/// it is empty.
11221122
///
11231123
/// # Examples

0 commit comments

Comments
 (0)