bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #41019 - mandeep:fix-vec-swapremove-docs, r=BurntSushi

Browse source 
Fixed typo in doc comments for swap_remove

While reading the Vec docs, I came across the docs for swap_remove. I believe there is a typo in the comment and ```return``` should be ```returns```. This PR fixes this issue.

I also feel that the entire doc comment is a bit of a run-on and could be changed to something along the lines of ```Removes an element from anywhere in the vector and returns it. The vector is mutated and the removed element is replaced by the last element of the vector. ```

Thoughts?
This commit is contained in:
Corey Farwell 2017-04-05 12:44:33 -04:00 • committed by GitHub
commit 5935fe47a9
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/libcollections/vec.rs
View file

@ -678,8 +678,9 @@ impl<T> Vec<T> {
self.len = len;
}
/// Removes an element from anywhere in the vector and return it, replacing
/// it with the last element.
/// Removes an element from the vector and returns it.
///
/// The removed element is replaced by the last element of the vector.
///
/// This does not preserve ordering, but is O(1).
///