Mirrorlandia_minetest/mod-wdata
1
0
Fork 0
mirror of https://github.com/AntumMT/mod-wdata.git synced 2024-11-19 22:13:45 +01:00
Code Issues Projects Releases Wiki Activity

Escape underscores in docstrings

Browse Source
This commit is contained in:
Jordan Irwin 2021-08-28 19:22:20 -07:00
parent 735d3efcda
commit 1a7b650403
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api.lua
View File

@ -30,7 +30,7 @@ end
--- Reads config file from world directory.
--
-- @function wdata.read
-- @tparam string fname Base filename with optional directory structure (e.g. "my_mod/my_config")
-- @tparam string fname Base filename with optional directory structure (e.g. "my\_mod/my\_config")
-- @treturn table Table with contents read from json file or `nil`.
function wdata.read(fname)
local fpath = world_path .. "/" .. fname .. ".json"
@ -64,7 +64,7 @@ end
--- Writes to config file in world directory.
--
-- @function wdata.write
-- @tparam string fname Base filename with optional directory structure (e.g. "my_mod/my_config").
-- @tparam string fname Base filename with optional directory structure (e.g. "my\_mod/my\_config").
-- @tparam table data Table data to be written to config file.
-- @tparam[opt] FlagsDef flags
-- @treturn bool `true` if succeeded, `false` if not.