浏览代码

Add a note for `String::reverse` to warn about its implementation

Yuri Rubinsky 1 年之前
父节点
当前提交
d0af8901aa
共有 2 个文件被更改,包括 2 次插入2 次删除
  1. 1 1
      doc/classes/String.xml
  2. 1 1
      doc/classes/StringName.xml

+ 1 - 1
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">

+ 1 - 1
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">