aboutsummaryrefslogtreecommitdiffstats
path: root/lualib/lua_maps.lua
diff options
context:
space:
mode:
authorAndrew Lewis <nerf@judo.za.org>2023-11-06 14:17:58 +0200
committerAndrew Lewis <nerf@judo.za.org>2023-11-06 14:17:58 +0200
commitb189c9fea6334cc9211b73d76acd05e7f1f71913 (patch)
treefc3805806b6ccff970e2912dddbd964a5783c3a9 /lualib/lua_maps.lua
parented77d35c7929cb0e84abf7ccde8efa05775b746d (diff)
downloadrspamd-b189c9fea6334cc9211b73d76acd05e7f1f71913.tar.gz
rspamd-b189c9fea6334cc9211b73d76acd05e7f1f71913.zip
[Minor] lua_maps docs: apply formatting
Diffstat (limited to 'lualib/lua_maps.lua')
-rw-r--r--lualib/lua_maps.lua20
1 files changed, 10 insertions, 10 deletions
diff --git a/lualib/lua_maps.lua b/lualib/lua_maps.lua
index baaed5b50..1bcce6066 100644
--- a/lualib/lua_maps.lua
+++ b/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,
--- for 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
+-- @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
+-- 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')