Auto merge of #74741 - aticu:master, r=jonas-schievink

Improve documentation of `String::from_raw_parts`

1 files changed, 3 insertions, 2 deletions

diff --git a/src/liballoc/string.rs b/src/liballoc/string.rs
index f41c8c5a559..05398ca68c8 100644
--- a/src/liballoc/string.rs
+++ b/src/liballoc/string.rs
@@ -667,15 +667,16 @@ impl String {
     /// This is highly unsafe, due to the number of invariants that aren't
     /// checked:
     ///
-    /// * The memory at `ptr` needs to have been previously allocated by the
+    /// * The memory at `buf` needs to have been previously allocated by the
     ///   same allocator the standard library uses, with a required alignment of exactly 1.
     /// * `length` needs to be less than or equal to `capacity`.
     /// * `capacity` needs to be the correct value.
+    /// * The first `length` bytes at `buf` need to be valid UTF-8.
     ///
     /// Violating these may cause problems like corrupting the allocator's
     /// internal data structures.
     ///
-    /// The ownership of `ptr` is effectively transferred to the
+    /// The ownership of `buf` is effectively transferred to the
     /// `String` which may then deallocate, reallocate or change the
     /// contents of memory pointed to by the pointer at will. Ensure
     /// that nothing else uses the pointer after calling this