Skip to content

Commit

Permalink
Fix documentation for string functions
Browse files Browse the repository at this point in the history
  • Loading branch information
kaeza authored and ShadowNinja committed Dec 30, 2014
1 parent c6df2bc commit cfec470
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/lua_api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1378,9 +1378,11 @@ math.hypot(x, y)
math.sign(x, tolerance)
^ Get the sign of a number
Optional: Also returns 0 when the absolute value is within the tolerance (default 0)
string:split(separator)
^ e.g. string:split("a,b", ",") == {"a","b"}
string:trim()
string.split(str, separator=",", include_empty=false, max_splits=-1, sep_is_pattern=false)
^ If max_splits is negative, do not limit splits.
^ sep_is_pattern specifies if separator is a plain string or a pattern (regex).
^ e.g. string.split("a,b", ",") == {"a","b"}
string.trim(str)
^ e.g. string.trim("\n \t\tfoo bar\t ") == "foo bar"
minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
^ Convert position to a printable string
Expand Down

0 comments on commit cfec470

Please sign in to comment.