docs: clarify explicitly freeing heap allocated memory

rust-lang · Nov 4, 2023 · ac47cd1 · ac47cd1
1 parent f1b104f
commit ac47cd1
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/library/alloc/src/boxed.rs b/library/alloc/src/boxed.rs
@@ -1044,7 +1044,12 @@ impl<T: ?Sized, A: Allocator> Box<T, A> {
     ///     dealloc(p as *mut u8, Layout::new::<String>());
     /// }
     /// ```
-    ///
+    /// Note: This is equivalent to the following:
+    /// ```
+    /// let x = Box::new(String::from("Hello"));
+    /// let p = Box::into_raw(x);
+    /// drop(Box::from_raw(ptr));
+    /// ```
     /// [memory layout]: self#memory-layout
     #[stable(feature = "box_raw", since = "1.4.0")]
     #[inline]