docs(g.table): Improve parameter descriptions

This commit is contained in:
Lucas Schwiderski 2021-03-08 15:55:32 +01:00
parent 95558ac919
commit ec3788bf73
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 9 additions and 7 deletions

View File

@ -230,14 +230,16 @@ end
-- `first_index` has to be specified. -- `first_index` has to be specified.
-- --
-- @tparam table t The input table. -- @tparam table t The input table.
-- @param value A value from the table. -- @param value The start value. Must be an element of the input table `t`.
-- @tparam[opt=1] number step_size How many element forward (or backward) to pick. -- @tparam[opt=1] number step_size The amount to increment the index by.
-- @tparam[opt=nil] function filter An optional function. When it returns -- When this is negative, the function will cycle through the table backwards.
-- `false`, the element are skipped until a match if found. It takes the value -- @tparam[opt=nil] function filter An optional filter function. It receives a
-- as its sole parameter. -- value from the table as parameter and should return a boolean. If it
-- returns `false`, the value is skipped and `cycle_value` tries the next one.
-- @tparam[opt=1] number start_at Where to start the lookup from. -- @tparam[opt=1] number start_at Where to start the lookup from.
-- @return The value. If no element match, then `nil` is returned. -- @return The next eligible value. If no value matches, `nil` is returned.
-- @treturn number|nil The element (if any) key. -- @treturn number|nil If a value is found, this is its index within the input
-- table.
-- @staticfct gears.table.cycle_value -- @staticfct gears.table.cycle_value
function gtable.cycle_value(t, value, step_size, filter, start_at) function gtable.cycle_value(t, value, step_size, filter, start_at)
local k = gtable.hasitem(t, value, true, start_at) local k = gtable.hasitem(t, value, true, start_at)