summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-11-13 14:03:14 +0100
committerGitHub <noreply@github.com>2019-11-13 14:03:14 +0100
commitd3a852f1241306eb697c0e2c072aa9bda09a4f7c (patch)
tree6d67fc7beb0e0caa7da283413a783d28aba1d4db
parenta439c55eff9fce48d64a16bc634783aec1ccd82f (diff)
parent79aca6b0c02bfbfd4bf1817baebe1786012c377c (diff)
Merge pull request #33591 from zaksnet/fix-string-docs-split
Fix split/rsplit docs
-rw-r--r--doc/classes/String.xml19
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index e0a4a24299..11a9f6dc0d 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -744,7 +744,15 @@
Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right.
The splits in the returned array are sorted in the same order as the original string, from left to right.
If [code]maxsplit[/code] is specified, it defines the number of splits to do from the right up to [code]maxsplit[/code]. The default value of 0 means that all items are split, thus giving the same result as [method split].
- For example, [code]"One,Two,Three,Four"[/code] will return [code]["Three","Four"][/code] if split by [code]","[/code] with a [code]maxsplit[/code] value of 2.
+ Example:
+ [codeblock]
+ var some_string = "One,Two,Three,Four"
+ var some_array = some_string.rsplit(",", true, 1)
+ print(some_array.size()) # Prints 2
+ print(some_array[0]) # Prints "Four"
+ print(some_array[1]) # Prints "Three,Two,One"
+ [/codeblock]
+
</description>
</method>
<method name="rstrip">
@@ -805,7 +813,14 @@
<description>
Splits the string by a [code]delimiter[/code] string and returns an array of the substrings.
If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of 0 means that all items are split.
- For example, [code]"One,Two,Three"[/code] will return [code]["One","Two"][/code] if split by [code]","[/code] with a [code]maxsplit[/code] value of 2.
+ Example:
+ [codeblock]
+ var some_string = "One,Two,Three,Four"
+ var some_array = some_string.split(",", true, 1)
+ print(some_array.size()) # Prints 2
+ print(some_array[0]) # Prints "One"
+ print(some_array[1]) # Prints "Two,Three,Four"
+ [/codeblock]
</description>
</method>
<method name="split_floats">