Document that write_json will error on unserializable types. (#5539)
authorraymoo <raymoo@users.noreply.github.com>
Sat, 8 Apr 2017 08:42:59 +0000 (01:42 -0700)
committerLoïc Blot <nerzhul@users.noreply.github.com>
Sat, 8 Apr 2017 08:42:59 +0000 (10:42 +0200)
Previously it was erroneously documented that it would save them as null.

doc/client_lua_api.md
doc/lua_api.txt

index d68f90deca62fd52ef64cf921c7a2f7408142e12..bee53636ca46e33ac9d87ccf6fd7911f9ff31b8e 100644 (file)
@@ -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.
index 0d3f00c67873d699a4708c7b6f4a52314cc0cb4d..ca1b5d14c446e6fd572b0999fe138cf1ed1d4b91 100644 (file)
@@ -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.