Skip to content
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

Jump to bottom

Improve some docs for VecDeque #40949

Merged
merged 2 commits into from Apr 5, 2017
Merged

Improve some docs for VecDeque #40949

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7b3f05
Improve some docs for VecDeque
Mar 31, 2017
1e2a61d
Change wording for push_front
Apr 1, 2017
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
18 changes: 9 additions & 9 deletions src/libcollections/vec_deque.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ impl<T> VecDeque<T> {
}
}

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

/// Provides a reference to the front element, or `None` if the sequence is
/// Provides a reference to the front element, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -966,7 +966,7 @@ impl<T> VecDeque<T> {
}

/// Provides a mutable reference to the front element, or `None` if the
/// sequence is empty.
/// `VecDeque` is empty.
///
/// # Examples
///
Expand All @@ -993,7 +993,7 @@ impl<T> VecDeque<T> {
}
}

/// Provides a reference to the back element, or `None` if the sequence is
/// Provides a reference to the back element, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -1018,7 +1018,7 @@ impl<T> VecDeque<T> {
}

/// Provides a mutable reference to the back element, or `None` if the
/// sequence is empty.
/// `VecDeque` is empty.
///
/// # Examples
///
Expand Down Expand Up @@ -1046,7 +1046,7 @@ impl<T> VecDeque<T> {
}
}

/// Removes the first element and returns it, or `None` if the sequence is
/// Removes the first element and returns it, or `None` if the `VecDeque` is
/// empty.
///
/// # Examples
Expand All @@ -1073,7 +1073,7 @@ impl<T> VecDeque<T> {
}
}

/// Inserts an element first in the sequence.
/// Prepends an element to the front of the `VecDeque`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Preprend means inserting to the front, no?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For push_back we have this sentence: Appends an element to the back of the VecDeque.

I just mirrored that wording for push_front. :) Do you have a better suggestion?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it does

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just "prepends an element to the VecDeque".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

///
/// # Examples
///
Expand All @@ -1096,7 +1096,7 @@ impl<T> VecDeque<T> {
}
}

/// Appends an element to the back of a buffer
/// Appends an element to the back of the `VecDeque`.
///
/// # Examples
///
Expand All @@ -1117,7 +1117,7 @@ impl<T> VecDeque<T> {
unsafe { self.buffer_write(head, value) }
}

/// Removes the last element from a buffer and returns it, or `None` if
/// Removes the last element from the `VecDeque` and returns it, or `None` if
/// it is empty.
///
/// # Examples
Expand Down