Document why `str.to_{lower,upper}case` return `String`

Fixes #39201.

1 files changed, 8 insertions, 0 deletions

diff --git a/src/libcollections/str.rs b/src/libcollections/str.rs
index 87315fff0a0..e27c4577344 100644
--- a/src/libcollections/str.rs
+++ b/src/libcollections/str.rs
@@ -1646,6 +1646,10 @@ impl str {
     /// 'Lowercase' is defined according to the terms of the Unicode Derived Core Property
     /// `Lowercase`.
     ///
+    /// Since some characters can expand into multiple characters when changing
+    /// the case, this function returns a [`String`] instead of modifying the
+    /// parameter in-place.
+    ///
     /// [`String`]: string/struct.String.html
     ///
     /// # Examples
@@ -1718,6 +1722,10 @@ impl str {
     /// 'Uppercase' is defined according to the terms of the Unicode Derived Core Property
     /// `Uppercase`.
     ///
+    /// Since some characters can expand into multiple characters when changing
+    /// the case, this function returns a [`String`] instead of modifying the
+    /// parameter in-place.
+    ///
     /// [`String`]: string/struct.String.html
     ///
     /// # Examples