summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-01-11 12:02:58 +0100
committerGitHub <noreply@github.com>2021-01-11 12:02:58 +0100
commit2830a152de98bb8e1f09a3228375028699f033ef (patch)
treea01a9c910c1fb1a8e306d2ff07c797e36789b1b4
parent29db5bd25e4ae475bd3eff127f3f0dfd7caaec70 (diff)
parenta2c82bbf5f500204355f48228e08ea207c8a14c0 (diff)
Merge pull request #45077 from Xrayez/fix-lstrip/rstrip-docs
Clarify `lstrip()/rstrip()` methods in `String` for removed characters
-rw-r--r--doc/classes/String.xml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index 79f21a0e70..fcc70d166e 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -406,7 +406,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">
@@ -698,7 +699,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">