From cfec470b513f06670fd7b791aca62fd2c8384c53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Mart=C3=ADnez?= Date: Mon, 29 Dec 2014 20:46:24 -0300 Subject: [PATCH] Fix documentation for string functions --- doc/lua_api.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 7dae2c58a..642ac4130 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -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