Skip to content

Improve doc of some methods that take ranges #140983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve doc of some methods that take ranges #140983

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1d5910
📝 docs: improve doc of some methods w/ ranges
tkr-sh May 13, 2025
77c1291
✏️ fix: one of the range "s/bound/bounds"
tkr-sh May 17, 2025
375f6fe
🚚 refactor: rename from "one of the" to "a"
tkr-sh May 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions library/alloc/src/collections/vec_deque/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1458,8 +1458,8 @@ impl<T, A: Allocator> VecDeque<T, A> {
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the deque.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and greater than the length of the deque.
///
/// # Examples
///
Expand Down Expand Up @@ -1494,8 +1494,8 @@ impl<T, A: Allocator> VecDeque<T, A> {
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the deque.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and greater than the length of the deque.
///
/// # Examples
///
Expand Down Expand Up @@ -1540,8 +1540,8 @@ impl<T, A: Allocator> VecDeque<T, A> {
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the deque.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and greater than the length of the deque.
///
/// # Leaking
///
Expand Down
12 changes: 6 additions & 6 deletions library/alloc/src/string.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1116,8 +1116,8 @@ impl String {
///
/// # Panics
///
/// Panics if the starting point or end point do not lie on a [`char`]
/// boundary, or if they're out of bounds.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and does not lie on a [`char`] boundary.
///
/// # Examples
///
Expand Down Expand Up @@ -1920,8 +1920,8 @@ impl String {
///
/// # Panics
///
/// Panics if the starting point or end point do not lie on a [`char`]
/// boundary, or if they're out of bounds.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and does not lie on a [`char`] boundary.
///
/// # Leaking
///
Expand Down Expand Up @@ -2030,8 +2030,8 @@ impl String {
///
/// # Panics
///
/// Panics if the starting point or end point do not lie on a [`char`]
/// boundary, or if they're out of bounds.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and does not lie on a [`char`] boundary.
///
/// # Examples
///
Expand Down
8 changes: 4 additions & 4 deletions library/alloc/src/vec/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2606,8 +2606,8 @@ impl<T, A: Allocator> Vec<T, A> {
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the vector.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and greater than the length of the vector.
///
/// # Leaking
///
Expand Down Expand Up @@ -3615,8 +3615,8 @@ impl<T, A: Allocator> Vec<T, A> {
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the vector.
/// Panics if the range has `start_bound > end_bound`, or, one of the range
/// bound is bounded and greater than the length of the vector.
///
/// # Examples
///
Expand Down
Loading