mirrors/etlua
1
0
Fork 0
mirror of https://github.com/TangentFoxy/etlua.git synced 2025-07-28 02:52:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

more readme updates

Browse Source
This commit is contained in:
leaf corcoran
2014-02-01 12:41:44 -08:00
parent dc9e81edda
commit c9125755d9
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -107,17 +107,17 @@ _b[_b_i] = ""
return _b return _b
``` ```
There are a few interesting things, there are no global variable references, There are a few interesting things: there are no global variable references,
all required values are passed in as arguments. Comments are inserted to all required values are passed in as arguments, and comments are inserted to
annotate the positions of where code originated from. `_b` is expected to be a annotate the positions of where code originated from. `_b` is expected to be a
regular Lua table that is the buffer where chunks of the template are inserted regular Lua table that is the buffer where chunks of the template are inserted
into. as it's executed.
#### `fn, err = parser.load(lua_code)` #### `fn, err = parser.load(lua_code)`
Converts the Lua code returned by `parser.compile_to_lua` into an actual Converts the Lua code returned by `parser.compile_to_lua` into an actual
function object. If there are any syntax errors then `nil` is returned along function object. If there are any syntax errors then `nil` is returned along
with the error message. At this stage, syntax errors are rewritten to point to with the error message. At this stage syntax errors are rewritten to point to
the original location in the etlua code and not the generated code. the original location in the etlua code and not the generated code.
#### `result = parser.run(fn, env={}, buffer={})` #### `result = parser.run(fn, env={}, buffer={})`
@@ -146,5 +146,5 @@ print(table.concat(buffer)) -- print 'Hello World'
## License ## License
MIT, Copyright (C) 2013 by Leaf Corcoran MIT, Copyright (C) 2014 by Leaf Corcoran