From a208842b9d2e62ffeaa8d6b7e02ce523efae033c Mon Sep 17 00:00:00 2001
From: Tobias Bucher <tobiasbucher5991@gmail.com>
Date: Fri, 27 Jun 2014 10:51:56 +0200
Subject: [PATCH] Add remark and an example about the bounds of `Vec::insert`

---
 src/libcollections/vec.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/libcollections/vec.rs b/src/libcollections/vec.rs
index 0ee0c5b87ae..4cca5979144 100644
--- a/src/libcollections/vec.rs
+++ b/src/libcollections/vec.rs
@@ -956,7 +956,8 @@ impl<T> Vec<T> {
     ///
     /// # Failure
     ///
-    /// Fails if `index` is out of bounds of the vector.
+    /// Fails if `index` is not between `0` and the vector's length (both
+    /// bounds inclusive).
     ///
     /// # Example
     ///
@@ -964,6 +965,8 @@ impl<T> Vec<T> {
     /// let mut vec = vec!(1i, 2, 3);
     /// vec.insert(1, 4);
     /// assert_eq!(vec, vec!(1, 4, 2, 3));
+    /// vec.insert(4, 5);
+    /// assert_eq!(vec, vec!(1, 4, 2, 3, 5));
     /// ```
     pub fn insert(&mut self, index: uint, element: T) {
         let len = self.len();