diff options
| -rw-r--r-- | doc/lua-filters.md | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md index 01b854b71..3c4f1f0c8 100644 --- a/doc/lua-filters.md +++ b/doc/lua-filters.md @@ -2665,33 +2665,14 @@ methods and convenience functions. : Returns a (shallow) copy of the list. -[`pandoc.List:new([table])`]{#pandoc.list:new} - -: Create a new List. If the optional argument `table` is given, - set the metatable of that value to `pandoc.List`. - - Parameters: - - `table`: - : table which should be treatable as a list; defaults to an - empty table - - Returns: the updated input value - -[`pandoc.List:includes (needle, init)`]{#pandoc.list:includes} +[`pandoc.List:extend (list)`]{#pandoc.list:extend} -: Checks if the list has an item equal to the given needle. +: Adds the given list to the end of this list. Parameters: - `needle`: - : item to search for - - `init`: - : index at which the search is started - - Returns: true if a list item is equal to the needle, false - otherwise + `list`: + : list to appended [`pandoc.List:find (needle, init)`]{#pandoc.list:find} @@ -2725,14 +2706,33 @@ methods and convenience functions. Returns: first item for which \`test\` succeeds, or nil if no such item exists. -[`pandoc.List:extend (list)`]{#pandoc.list:extend} +[`pandoc.List:filter (pred)`]{#pandoc.list:filter} -: Adds the given list to the end of this list. +: Returns a new list containing all items satisfying a given + condition. Parameters: - `list`: - : list to appended + `pred`: + : condition items must satisfy. + + Returns: a new list containing all items for which \`test\` + was true. + +[`pandoc.List:includes (needle, init)`]{#pandoc.list:includes} + +: Checks if the list has an item equal to the given needle. + + Parameters: + + `needle`: + : item to search for + + `init`: + : index at which the search is started + + Returns: true if a list item is equal to the needle, false + otherwise [`pandoc.List:map (fn)`]{#pandoc.list:map} @@ -2744,18 +2744,18 @@ methods and convenience functions. `fn`: : function which is applied to all list items. -[`pandoc.List:filter (pred)`]{#pandoc.list:filter} +[`pandoc.List:new([table])`]{#pandoc.list:new} -: Returns a new list containing all items satisfying a given - condition. +: Create a new List. If the optional argument `table` is given, + set the metatable of that value to `pandoc.List`. Parameters: - `pred`: - : condition items must satisfy. + `table`: + : table which should be treatable as a list; defaults to an + empty table - Returns: a new list containing all items for which \`test\` - was true. + Returns: the updated input value # Module pandoc.system |