Skip to content

Minor fixes to doc comments of 'VecDeque' #71219

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

Merged
merged 1 commit into from
Apr 17, 2020
Merged

Minor fixes to doc comments of 'VecDeque' #71219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 src/liballoc/collections/vec_deque.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ impl<T> VecDeque<T> {
VecDeque { tail: 0, head: 0, buf: RawVec::with_capacity(cap) }
}

/// Retrieves an element in the `VecDeque` by index.
/// Provides a reference to the element at the given index.
///
/// Element at index 0 is the front of the queue.
///
Expand All @@ -513,7 +513,7 @@ impl<T> VecDeque<T> {
}
}

/// Retrieves an element in the `VecDeque` mutably by index.
/// Provides a mutable reference to the element at the given index.
///
/// Element at index 0 is the front of the queue.
///
Expand Down Expand Up @@ -651,7 +651,7 @@ impl<T> VecDeque<T> {
}
}

/// Tries to reserves the minimum capacity for exactly `additional` more elements to
/// Tries to reserve the minimum capacity for exactly `additional` more elements to
/// be inserted in the given `VecDeque<T>`. After calling `reserve_exact`,
/// capacity will be greater than or equal to `self.len() + additional`.
/// Does nothing if the capacity is already sufficient.
Expand All @@ -662,7 +662,7 @@ impl<T> VecDeque<T> {
///
/// # Errors
///
/// If the capacity overflows, or the allocator reports a failure, then an error
/// If the capacity overflows `usize`, or the allocator reports a failure, then an error
/// is returned.
///
/// # Examples
Expand All @@ -678,7 +678,7 @@ impl<T> VecDeque<T> {
/// // Pre-reserve the memory, exiting if we can't
/// output.try_reserve_exact(data.len())?;
///
/// // Now we know this can't OOM in the middle of our complex work
/// // Now we know this can't OOM(Out-Of-Memory) in the middle of our complex work
/// output.extend(data.iter().map(|&val| {
/// val * 2 + 5 // very complicated
/// }));
Expand All @@ -700,7 +700,7 @@ impl<T> VecDeque<T> {
///
/// # Errors
///
/// If the capacity overflows, or the allocator reports a failure, then an error
/// If the capacity overflows `usize`, or the allocator reports a failure, then an error
/// is returned.
///
/// # Examples
Expand Down