Improve Lua API documentation
authorCiaran Gultnieks <ciaran@ciarang.com>
Mon, 17 Mar 2014 20:05:35 +0000 (20:05 +0000)
committerShadowNinja <shadowninja@minetest.net>
Fri, 28 Nov 2014 23:35:45 +0000 (18:35 -0500)
commitc30346ea3093ed96693e628493f5722c615ba138
tree4b8a67e146336eabd97c3694f416f01763c46f40
parent2b1a151226ae274ca652e72e95b840199e9389b8
Improve Lua API documentation

Changes:
  * Add extra documentation for remove_item.

    This isn't as silly as it sounds: iterate a list containing items with
    unique metadata each, and remove_item the first one you find, placing
    into a different - fine, except the remove will invariably remove the
    wrong one, leading to items being duplicated and others destroyed.

    Arguably it's a bug, and Inventory::removeItem should actually remove
    the item you tell it to. (i.e. if the passed ItemStack has metadata,
    match it). But it seems reasonable to just document the behaviour
    more clearly.

 * Improve string_to_pos documentation.
 * Clarify dig_node documentation (return value).
 * Better on_step documentation.
 * get_nodemeta -> get_meta.
 * Other minor fixes.
doc/lua_api.txt