From 9a2e3f3a8e032ae7b39c33bc7cc8f25ebbef8a8e Mon Sep 17 00:00:00 2001
From: Flying-Toast <38232168+Flying-Toast@users.noreply.github.com>
Date: Fri, 30 Jul 2021 16:01:49 -0400
Subject: [PATCH] Recommend `swap_remove` in `Vec::remove` docs

---
 library/alloc/src/vec/mod.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs
index 06a7c335bf05d..61e018285ce66 100644
--- a/library/alloc/src/vec/mod.rs
+++ b/library/alloc/src/vec/mod.rs
@@ -1360,6 +1360,12 @@ impl<T, A: Allocator> Vec<T, A> {
     /// Removes and returns the element at position `index` within the vector,
     /// shifting all elements after it to the left.
     ///
+    /// Note: Because this shifts over the remaining elements, it has a
+    /// worst-case performance of O(n). If you don't need the order of elements
+    /// to be preserved, use [`swap_remove`] instead.
+    ///
+    /// [`swap_remove`]: Vec::swap_remove
+    ///
     /// # Panics
     ///
     /// Panics if `index` is out of bounds.