From 418535b798946b29c70a3ac4e33bbc6fbb4fb132 Mon Sep 17 00:00:00 2001 From: Jani Mustonen <janijohannes@kapsi.fi> Date: Mon, 1 Apr 2024 00:04:57 +0300 Subject: [PATCH] doc: mention heap allocation earlier in String docs Just a tiny addition. Helps with #123263. --- library/alloc/src/string.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/library/alloc/src/string.rs b/library/alloc/src/string.rs index 7464df268cc..5d552c8f15c 100644 --- a/library/alloc/src/string.rs +++ b/library/alloc/src/string.rs @@ -72,9 +72,9 @@ use crate::vec::Vec; /// A UTF-8–encoded, growable string. /// -/// The `String` type is the most common string type that has ownership over the -/// contents of the string. It has a close relationship with its borrowed -/// counterpart, the primitive [`str`]. +/// `String` is the most common string type. It has ownership over the contents +/// of the string, stored in a heap-allocated buffer (see [Representation](#representation)). +/// It is closely related to its borrowed counterpart, the primitive [`str`]. /// /// # Examples ///