@@ -10,7 +10,7 @@ functional languages. #### Sequences {#sequence} -This library provides several functions that work with a "sequence". A sequence +This library provides several functions that work with a `sequence`. A sequence as defined by this library is something that can be iterated over. A Lua table is a sequence and can be passed to any function that accepts a sequence. In addition, it is possible to use a "wrapped iterator" as a sequence. A @@ -32,7 +32,7 @@ results in: abce -The example above uses a custom iterator from the functional module, nipairs, +The example above uses a custom iterator from the functional module, [nipairs](#nipairs), which iterates through a spare array until it hits the last index. The iterator is "wrapped" with [wrap_iter](#wrap_iter), which creates a single object that can be passed as a sequence to a higher-order function. @@ -41,9 +41,12 @@ can be passed as a sequence to a higher-order function. In Lua the most basic data structure is a table, not a list as in most functional languages. Most higher-order functions in this project treat -sequences as arrays. That is, they are treated as they have a well-defined -order and the keys are ignored. Only where specifically stated do higher-order -functions use tables as an unordered collection of key/value pairs. +sequences as arrays. That is, they are treated as if they have a well-defined +order (determined by numeric index), the values of non-numeric keys are ignored, +and the keys are not passed to functions. + +Only where specifically stated do higher-order functions use tables as an +unordered collection of key/value pairs. [ipairs]: http://www.lua.org/manual/5.1/manual.html#pdf-ipairs [generic for]: http://www.lua.org/pil/7.2.html README @@ -9,7 +9,8 @@ input = assert(io.open('README')) output:write(input:read("*a")) input:close() --- Then pull in docs from the source +-- Then pull in the function reference from the source +output:write("### Function Reference {#reference}\n\n") input = assert(io.open('functional.lua')) for line in input:lines() do if in_block_comment then doc.lua @@ -1,8 +1,4 @@ ---[[[ - -### Function Reference {#reference} -]] - +-- Save global environment in g and start functional namespace local g = _G module('functional') functional.lua 5d44d721146acaf30dc6591088f5d1f49d472d5a Chris Pettitt cpettitt@gmail.com http://github.com/samsarin/lua-functional/commit/f9c7ccf97e42b4efe16ad34c86b59c38c32bcd0c f9c7ccf97e42b4efe16ad34c86b59c38c32bcd0c 2008-05-30T07:05:38-07:00 2008-05-30T07:05:38-07:00 Minor doc changes. - Use more markup and linking in README - Remove "Functional Reference" header from functional.lua - Add some documentation about the functional namespace 445215a660de26ee3d3ac7e0ce1493af2e430c98 Chris Pettitt cpettitt@gmail.com