浏览代码

[Minor] lua_maps docs: apply formatting

tags/3.8.0
Andrew Lewis 6 个月前
父节点
当前提交
b189c9fea6
共有 1 个文件被更改,包括 10 次插入7 次删除
  1. 10
    7
      lualib/lua_maps.lua

+ 10
- 7
lualib/lua_maps.lua 查看文件

@@ -553,17 +553,17 @@ exports.rspamd_maybe_check_map = rspamd_maybe_check_map
-- @function lua_maps.fill_config_maps(mname, options, defs)
-- Fill maps that could be defined in defs, from the config in the options
-- Defs is a table indexed by a map's parameter name and defining it's config,
defs = {
my_map = {
type = 'map',
description = 'my cool map',
optional = true,
}
}
-- @example
-- defs = {
-- my_map = {
-- type = 'map',
-- description = 'my cool map',
-- optional = true,
-- }
-- }
-- --[[ Then this function will look for opts.my_map parameter and try to replace it's with
-- a map with the specific type, description but not failing if it was empty.
-- It will also set options.my_map_orig to the original value defined in the map --]]
--]]
exports.fill_config_maps = function(mname, opts, map_defs)
assert(type(opts) == 'table')

正在加载...
取消
保存