diff options
| author | Cameron Sun <cameron.csun@gmail.com> | 2015-10-28 21:38:46 -0400 |
|---|---|---|
| committer | Cameron Sun <cameron.csun@gmail.com> | 2015-10-28 21:38:46 -0400 |
| commit | 39289d00fdfe6e845e3325ff8f388cc40e9620f3 (patch) | |
| tree | a379cb63994700d2bd89a0917ac4802a03f3b287 /src | |
| parent | 8ca0acc25adb00d29e52b015bded4b2872a1170c (diff) | |
| download | rust-39289d00fdfe6e845e3325ff8f388cc40e9620f3.tar.gz rust-39289d00fdfe6e845e3325ff8f388cc40e9620f3.zip | |
Update docstring for truncate
This documentation confused me when trying to use truncate on a project. Originally, it was unclear whether truncate removed the last `len` elements, or whether it cut down the vector to be exactly `len` elements long. The example was also ambiguous.
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcollections/vec.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libcollections/vec.rs b/src/libcollections/vec.rs index 897fea5309c..adf3ec13cfd 100644 --- a/src/libcollections/vec.rs +++ b/src/libcollections/vec.rs @@ -429,7 +429,7 @@ impl<T> Vec<T> { } } - /// Shorten a vector, dropping excess elements. + /// Shorten a vector to be `len` elements long, dropping excess elements. /// /// If `len` is greater than the vector's current length, this has no /// effect. @@ -437,7 +437,7 @@ impl<T> Vec<T> { /// # Examples /// /// ``` - /// let mut vec = vec![1, 2, 3, 4]; + /// let mut vec = vec![1, 2, 3, 4, 5]; /// vec.truncate(2); /// assert_eq!(vec, [1, 2]); /// ``` |
