Fix documentation for string functions
authorDiego Martínez <kaeza@users.noreply.github.com>
Mon, 29 Dec 2014 23:46:24 +0000 (20:46 -0300)
committerShadowNinja <shadowninja@minetest.net>
Tue, 30 Dec 2014 05:42:50 +0000 (00:42 -0500)
doc/lua_api.txt

index 7dae2c58af41ac23a58e845ad4aaf12ed1b379aa..642ac4130104240c78a9fea05bc5cf424d599683 100644 (file)
@@ -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