about summary refs log tree commit diff
path: root/library/alloc
diff options
context:
space:
mode:
author许杰友 Jieyou Xu (Joe) <jieyouxu@outlook.com>2024-02-26 19:31:51 +0000
committer许杰友 Jieyou Xu (Joe) <jieyouxu@outlook.com>2024-02-26 19:32:32 +0000
commitbfeea294cc01c295ca5b54dcbfb59ee6953b4fc6 (patch)
tree81b50c68817710ca83c161e488b581c6e2b7e3bf /library/alloc
parentdd24a462d517cf2a0667adf92aaa38502b71b61c (diff)
downloadrust-bfeea294cc01c295ca5b54dcbfb59ee6953b4fc6.tar.gz
rust-bfeea294cc01c295ca5b54dcbfb59ee6953b4fc6.zip
Document args returned from `String::into_raw_parts`
Diffstat (limited to 'library/alloc')
-rw-r--r--library/alloc/src/string.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/library/alloc/src/string.rs b/library/alloc/src/string.rs
index 955438f49a1..1d3c04f7807 100644
--- a/library/alloc/src/string.rs
+++ b/library/alloc/src/string.rs
@@ -864,7 +864,7 @@ impl String {
         }
     }
 
-    /// Decomposes a `String` into its raw components.
+    /// Decomposes a `String` into its raw components: `(pointer, length, capacity)`.
     ///
     /// Returns the raw pointer to the underlying data, the length of
     /// the string (in bytes), and the allocated capacity of the data