about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAriel Ben-Yehuda <arielb1@mail.tau.ac.il>2017-03-08 20:54:10 +0200
committerGitHub <noreply@github.com>2017-03-08 20:54:10 +0200
commitf2886e8bda7d628ae0cc16e4fe579cbc2c6dc1b0 (patch)
tree106965b8ea1a63c183f757c51bac4009d4033991
parentaea8010098d6387f68440577b691e48e9ab5cc6a (diff)
parentf3a2f90c88c9d890b67955f0b88def40ce372914 (diff)
downloadrust-f2886e8bda7d628ae0cc16e4fe579cbc2c6dc1b0.tar.gz
rust-f2886e8bda7d628ae0cc16e4fe579cbc2c6dc1b0.zip
Rollup merge of #40335 - tbu-:pr_doc_str_to_somecase, r=steveklabnik
Document why `str.to_{lower,upper}case` return `String`

Fixes #39201.
-rw-r--r--src/libcollections/str.rs8
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