From: raymoo <raymoo@users.noreply.github.com>
Date: Sat, 8 Apr 2017 08:42:59 +0000 (-0700)
Subject: Document that write_json will error on unserializable types. (#5539)
X-Git-Tag: 0.4.16~268
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=fb4c730708a4140f05d2161c27e6c58bb0f72a9b;p=oweals%2Fminetest.git

Document that write_json will error on unserializable types. (#5539)

Previously it was erroneously documented that it would save them as null.
---

diff --git a/doc/client_lua_api.md b/doc/client_lua_api.md
index d68f90dec..bee53636c 100644
--- a/doc/client_lua_api.md
+++ b/doc/client_lua_api.md
@@ -712,7 +712,7 @@ Call these functions only at load time!
 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
     * Convert a Lua table into a JSON string
     * styled: Outputs in a human-readable format if this is set, defaults to false
-    * Unserializable things like functions and userdata are saved as null.
+    * Unserializable things like functions and userdata will cause an error.
     * **Warning**: JSON is more strict than the Lua table format.
         1. You can only use strings and positive integers of at least one as keys.
         2. You can not mix string and integer keys.
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 0d3f00c67..ca1b5d14c 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2709,7 +2709,7 @@ These functions return the leftover itemstack.
 * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
     * Convert a Lua table into a JSON string
     * styled: Outputs in a human-readable format if this is set, defaults to false
-    * Unserializable things like functions and userdata are saved as null.
+    * Unserializable things like functions and userdata will cause an error.
     * **Warning**: JSON is more strict than the Lua table format.
         1. You can only use strings and positive integers of at least one as keys.
         2. You can not mix string and integer keys.