From 80d167a6daf1e6df24d4751c1644b4ede6279080 Mon Sep 17 00:00:00 2001
From: Giang Dao <dtrnggiang@gmail.com>
Date: Mon, 24 Feb 2025 23:24:05 +0800
Subject: [PATCH] update doc for Vec::into_boxed_slice

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

diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs
index a84bb724473a1..cdbb643bb7b8b 100644
--- a/library/alloc/src/vec/mod.rs
+++ b/library/alloc/src/vec/mod.rs
@@ -1442,28 +1442,37 @@ impl<T, A: Allocator> Vec<T, A> {
 
     /// Converts the vector into [`Box<[T]>`][owned slice].
     ///
-    /// Before doing the conversion, this method discards excess capacity like [`shrink_to_fit`].
+    /// Before the conversion, this will attempt to shrink the vector's allocation to match its length,
+    /// but the final memory layout depends on the allocator's [memory fitting][memory-fitting] strategy.
+    /// The returned slice will have exactly [`len`] elements, but take note that the underlying allocation
+    /// may still contain unused capacity that is safe to use with sized deallocation methods.
     ///
+    /// When converting back to a vector using `Box<[T]>::into_vec`, the resulting
+    /// vector may retain this extra capacity. For details about allocator behavior,
+    /// see [`Allocator::shrink`] and the [memory fitting] documentation.
+    ///
+    /// [`len`]: Vec::len
     /// [owned slice]: Box
+    /// [memory-fitting]: Allocator#memory-fitting
     /// [`shrink_to_fit`]: Vec::shrink_to_fit
     ///
     /// # Examples
     ///
+    /// Basic conversion:
     /// ```
     /// let v = vec![1, 2, 3];
-    ///
     /// let slice = v.into_boxed_slice();
     /// ```
     ///
-    /// Any excess capacity is removed:
-    ///
+    /// Preserved allocation size when converting back:
     /// ```
     /// let mut vec = Vec::with_capacity(10);
     /// vec.extend([1, 2, 3]);
     ///
-    /// assert!(vec.capacity() >= 10);
     /// let slice = vec.into_boxed_slice();
-    /// assert_eq!(slice.into_vec().capacity(), 3);
+    /// let new_vec = slice.into_vec();
+    /// // The allocator may have kept extra capacity:
+    /// assert!(new_vec.capacity() >= 3);
     /// ```
     #[cfg(not(no_global_oom_handling))]
     #[stable(feature = "rust1", since = "1.0.0")]