godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved documentation of rsplit Method for String class. 

Improved documentation of rsplit Method for String class.

Removed "divisor" (i will also change variants_call.cpp) and added "delimiter" in its place. Also moved the example at the bottom of the description.
This commit is contained in:
Zak 2019-06-05 11:23:35 +03:00
parent b9dc2e7e4d
commit 1a397f46e6
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/variant_call.cpp
View File

@ -1519,9 +1519,9 @@ void register_variant_methods() {
ADDFUNC2R(STRING, STRING, String, replacen, STRING, "what", STRING, "forwhat", varray()); ADDFUNC2R(STRING, STRING, String, replacen, STRING, "what", STRING, "forwhat", varray());
ADDFUNC2R(STRING, STRING, String, insert, INT, "position", STRING, "what", varray()); ADDFUNC2R(STRING, STRING, String, insert, INT, "position", STRING, "what", varray());
ADDFUNC0R(STRING, STRING, String, capitalize, varray()); ADDFUNC0R(STRING, STRING, String, capitalize, varray());
ADDFUNC3R(STRING, POOL_STRING_ARRAY, String, split, STRING, "divisor", BOOL, "allow_empty", INT, "maxsplit", varray(true, 0)); ADDFUNC3R(STRING, POOL_STRING_ARRAY, String, split, STRING, "delimiter", BOOL, "allow_empty", INT, "maxsplit", varray(true, 0));
ADDFUNC3R(STRING, POOL_STRING_ARRAY, String, rsplit, STRING, "divisor", BOOL, "allow_empty", INT, "maxsplit", varray(true, 0)); ADDFUNC3R(STRING, POOL_STRING_ARRAY, String, rsplit, STRING, "delimiter", BOOL, "allow_empty", INT, "maxsplit", varray(true, 0));
ADDFUNC2R(STRING, POOL_REAL_ARRAY, String, split_floats, STRING, "divisor", BOOL, "allow_empty", varray(true)); ADDFUNC2R(STRING, POOL_REAL_ARRAY, String, split_floats, STRING, "delimiter", BOOL, "allow_empty", varray(true));
ADDFUNC0R(STRING, STRING, String, to_upper, varray()); ADDFUNC0R(STRING, STRING, String, to_upper, varray());
ADDFUNC0R(STRING, STRING, String, to_lower, varray()); ADDFUNC0R(STRING, STRING, String, to_lower, varray());

21
doc/classes/String.xml
View File

@ -662,16 +662,17 @@
<method name="rsplit"> <method name="rsplit">
<return type="PoolStringArray"> <return type="PoolStringArray">
</return> </return>
<argument index="0" name="divisor" type="String"> <argument index="0" name="delimiter" type="String">
</argument> </argument>
<argument index="1" name="allow_empty" type="bool" default="True"> <argument index="1" name="allow_empty" type="bool" default="True">
</argument> </argument>
<argument index="2" name="maxsplit" type="int" default="0"> <argument index="2" name="maxsplit" type="int" default="0">
</argument> </argument>
<description> <description>
Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right.
[b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two","Three"][/code] if split by [code]","[/code]. 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, then it is number of splits to do, default is 0 which splits all the items. 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].
[b]Example:[/b] [code]"One,Two,Three,Four"[/code] will return [code]["Three","Four"][/code] if split by [code]","[/code] with [code]maxsplit[/code] of 2.
</description> </description>
</method> </method>
<method name="rstrip"> <method name="rstrip">
@ -709,27 +710,27 @@
<method name="split"> <method name="split">
<return type="PoolStringArray"> <return type="PoolStringArray">
</return> </return>
<argument index="0" name="divisor" type="String"> <argument index="0" name="delimiter" type="String">
</argument> </argument>
<argument index="1" name="allow_empty" type="bool" default="True"> <argument index="1" name="allow_empty" type="bool" default="True">
</argument> </argument>
<argument index="2" name="maxsplit" type="int" default="0"> <argument index="2" name="maxsplit" type="int" default="0">
</argument> </argument>
<description> <description>
Splits the string by a divisor string and returns an array of the substrings. Splits the string by a [code]delimiter[/code] string and returns an array of the substrings.
[b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two","Three"][/code] if split by [code]","[/code]. 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.
If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) [b]Example:[/b] [code]"One,Two,Three"[/code] will return [code]["One","Two"][/code] if split by [code]","[/code] with [code]maxsplit[/code] of 2.
</description> </description>
</method> </method>
<method name="split_floats"> <method name="split_floats">
<return type="PoolRealArray"> <return type="PoolRealArray">
</return> </return>
<argument index="0" name="divisor" type="String"> <argument index="0" name="delimiter" type="String">
</argument> </argument>
<argument index="1" name="allow_empty" type="bool" default="True"> <argument index="1" name="allow_empty" type="bool" default="True">
</argument> </argument>
<description> <description>
Splits the string in floats by using a divisor string and returns an array of the substrings. Splits the string in floats by using a delimiter string and returns an array of the substrings.
[b]Example:[/b] [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. [b]Example:[/b] [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code].
</description> </description>
</method> </method>