library-mirrors/serpent
1
0
Fork 0
mirror of https://github.com/pkulchenko/serpent.git synced 2024-11-21 23:24:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated list formatting in the documentation for consistency.

Browse Source
This commit is contained in:
Paul Kulchenko 2017-08-31 22:19:50 -07:00
parent 5b5f694082
commit d304d81c09
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -63,24 +63,25 @@ Similar to `pcall` and `loadstring` calls, `load` returns status as the first va
## Options
* indent (string) -- indentation; triggers long multi-line output
* comment (true/false/maxlevel) -- provide stringified value in a comment (up to `maxlevel` of depth)
* sortkeys (true/false/function) -- sort keys
* sparse (true/false) -- force sparse encoding (no nil filling based on `#t`)
* compact (true/false) -- remove spaces
* fatal (true/False) -- raise fatal error on non-serilizable values
* nocode (true/False) -- disable bytecode serialization for easy comparison
* nohuge (true/False) -- disable checking numbers against undefined and huge values
* maxlevel (number) -- specify max level up to which to expand nested tables
* maxnum (number) -- specify max number of elements in a table
* maxlength (number) -- specify max length for all table elements
* numformat (string; "%.17g") -- specify format for numeric values (shortest possible round-trippable double)
* valignore (table) -- allows to specify a list of values to ignore (as keys)
* keyallow (table) -- allows to specify the list of keys to be serialized. Any keys not in this list are not included in final output (as keys)
* indent (string) -- indentation; triggers long multi-line output.
* comment (true/false/maxlevel) -- provide stringified value in a comment (up to `maxlevel` of depth).
* sortkeys (true/false/function) -- sort keys.
* sparse (true/false) -- force sparse encoding (no nil filling based on `#t`).
* compact (true/false) -- remove spaces.
* fatal (true/False) -- raise fatal error on non-serilizable values.
* nocode (true/False) -- disable bytecode serialization for easy comparison.
* nohuge (true/False) -- disable checking numbers against undefined and huge values.
* maxlevel (number) -- specify max level up to which to expand nested tables.
* maxnum (number) -- specify max number of elements in a table.
* maxlength (number) -- specify max length for all table elements.
* numformat (string; "%.17g") -- specify format for numeric values (shortest possible round-trippable double).
* valignore (table) -- allows to specify a list of values to ignore (as keys).
* keyallow (table) -- allows to specify the list of keys to be serialized.
Any keys not in this list are not included in final output (as keys).
* keyignore (table) -- allows to specity the list of keys to ignore in serialization.
* valtypeignore (table) -- allows to specify a list of value *types* to ignore (as keys)
* custom (function) -- provide custom output for tables
* name (string) -- name; triggers full serialization with self-ref section
* valtypeignore (table) -- allows to specify a list of value *types* to ignore (as keys).
* custom (function) -- provide custom output for tables.
* name (string) -- name; triggers full serialization with self-ref section.
These options can be provided as a second parameter to Serpent functions.