From d0af8901aad4ba00d1362b4c5aef9a85d44b2b45 Mon Sep 17 00:00:00 2001
From: Yuri Rubinsky <chaosus89@gmail.com>
Date: Mon, 29 Apr 2024 20:29:26 +0300
Subject: [PATCH] Add a note for `String::reverse` to warn about its
 implementation

---
 doc/classes/String.xml     | 2 +-
 doc/classes/StringName.xml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index a33a1aea4188..59733e969657 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -747,7 +747,7 @@
 		<method name="reverse" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns the copy of this string in reverse order.
+				Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis.
 			</description>
 		</method>
 		<method name="rfind" qualifiers="const">
diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml
index e837b65199ce..e3c254fb4865 100644
--- a/doc/classes/StringName.xml
+++ b/doc/classes/StringName.xml
@@ -648,7 +648,7 @@
 		<method name="reverse" qualifiers="const">
 			<return type="String" />
 			<description>
-				Returns the copy of this string in reverse order.
+				Returns the copy of this string in reverse order. This operation works on unicode codepoints, rather than sequences of codepoints, and may break things like compound letters or emojis.
 			</description>
 		</method>
 		<method name="rfind" qualifiers="const">