Skip to content

Commit

Permalink
doc: mention heap allocation earlier in String docs
Browse files Browse the repository at this point in the history
Just a tiny addition.

Helps with #123263.
  • Loading branch information
JaniM committed Mar 31, 2024
1 parent 688c30d commit 418535b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions library/alloc/src/string.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit 418535b

Please sign in to comment.