[3.x] Clarify String.get_slice behavior

Clarify that the function returns the whole string if there is no
instances of the delimiter in the string.

(cherry picked from commit dec7cb5548)
This commit is contained in:
Ninni Pipping
2023-06-20 10:41:53 +02:00
committed by Rémi Verschelde
parent d8f6c3aac6
commit 1cc210d1e9

View File

@@ -358,7 +358,7 @@
<argument index="0" name="delimiter" type="String" />
<argument index="1" name="slice" type="int" />
<description>
Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist.
Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns the original string if [code]delimiter[/code] does not occur in the string. Returns an empty string if the index doesn't exist.
This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index.
Example:
[codeblock]