浏览代码

Clarify `lstrip()/rstrip()` methods in `String` for removed characters

(cherry picked from commit a2c82bbf5f500204355f48228e08ea207c8a14c0)
Andrii Doroshenko (Xrayez) 4 年之前
父节点
当前提交
9c9ac159e9
共有 1 个文件被更改,包括 4 次插入2 次删除
  1. 4 2
      doc/classes/String.xml

+ 4 - 2
doc/classes/String.xml

@@ -585,7 +585,8 @@
 			<argument index="0" name="chars" type="String">
 			</argument>
 			<description>
-				Returns a copy of the string with characters removed from the left.
+				Returns a copy of the string with characters removed from the left. The [code]chars[/code] argument is a string specifying the set of characters to be removed.
+				[b]Note:[/b] The [code]chars[/code] is not a prefix. See [method trim_prefix] method that will remove a single prefix string rather than a set of characters.
 			</description>
 		</method>
 		<method name="match">
@@ -773,7 +774,8 @@
 			<argument index="0" name="chars" type="String">
 			</argument>
 			<description>
-				Returns a copy of the string with characters removed from the right.
+				Returns a copy of the string with characters removed from the right. The [code]chars[/code] argument is a string specifying the set of characters to be removed.
+				[b]Note:[/b] The [code]chars[/code] is not a suffix. See [method trim_suffix] method that will remove a single suffix string rather than a set of characters.
 			</description>
 		</method>
 		<method name="sha1_buffer">