From: ANAND <ClobberXD@gmail.com>
Date: Sun, 19 Jan 2020 10:16:54 +0000 (+0530)
Subject: lua_api.txt: Improve privs_to_string and string_to_privs documentation (#9228)
X-Git-Tag: 5.2.0~226
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=468eb4bf5710e851b2599baeff870518f979c71a;p=oweals%2Fminetest.git

lua_api.txt: Improve privs_to_string and string_to_privs documentation (#9228)
---

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 57159d6ac..0b12913d5 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -4336,9 +4336,13 @@ Setting-related
 Authentication
 --------------
 
-* `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
-* `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
-    * Convert between two privilege representations
+* `minetest.string_to_privs(str[, delim])`:
+    * Converts string representation of privs into table form
+    * `delim`: String separating the privs. Defaults to `","`.
+    * Returns `{ priv1 = true, ... }`
+* `minetest.privs_to_string(privs[, delim])`:
+    * Returns the string representation of `privs`
+    * `delim`: String to delimit privs. Defaults to `","`.
 * `minetest.get_player_privs(name) -> {priv1=true,...}`
 * `minetest.check_player_privs(player_or_name, ...)`:
   returns `bool, missing_privs`