Skip to content

Commit

Permalink
Fix some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
AntumDeluge committed Aug 18, 2021
1 parent 45274b6 commit bf5b583
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 5 additions & 3 deletions command.lua
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,19 @@ local format_usage = function(cmd)
end


--- Manages shops config.
--- Manages shops & config.
--
-- @chatcmd server_shop
-- @param command Command to execute.
-- @param[opt] params Parameters associated with command.
-- @usage
-- /server_shop command [params]
-- /server_shop <command> [<params>]
--
-- Commands:
-- - reload
-- - Reloads shops configuration.
-- - register
-- - Registers new shop & adds to configuration.
-- - Registers new shop & updates configuration.
-- - parameters: <id> <sell/buy> <name> [product1=value,product2=value,...]
-- - unregister
-- - Unregisters shop & updates configuration.
Expand Down
4 changes: 2 additions & 2 deletions formspec.lua
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ end
--
-- @function server_shop.get_formspec
-- @tparam vector pos Shop node coordinates.
-- @tparam player ObjectRef Player to whom the formspec is shown.
-- @tparam ObjectRef player Player to whom the formspec is shown.
-- @tparam[opt] bool buyer `true` if the shop in question is a buyer shop (default: false).
-- @treturn string Formspec formatted string.
ss.get_formspec = function(id, player, buyer)
Expand Down Expand Up @@ -274,7 +274,7 @@ end
--
-- @function server_shop.show_formspec
-- @tparam vector pos Shop node coordinates.
-- @tparam player ObjectRef Player to whom the formspec is shown.
-- @tparam ObjectRef player Player to whom the formspec is shown.
-- @tparam[opt] bool buyer (deprecated)
ss.show_formspec = function(pos, player, buyer)
if buyer ~= nil then
Expand Down

0 comments on commit bf5b583

Please sign in to comment.