umgeher/jsx
0
Fork 0
Code Issues Pull requests Activity

Merge pull request #30 from macintux/macintux-readme-fix

Browse source 
Invert the description of encode
This commit is contained in:
alisdair sullivan 2013-03-11 00:51:58 -07:00
commit 6cfe5d6661
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.markdown
View file

@ -346,7 +346,7 @@ all three functions return an anonymous function that takes the appropriate type
`Args` is any term that will be passed to `Module:init/1` prior to syntactic analysis to produce an initial state
`Opts` are detailed [here](#option)
`Opts` are detailed [here](#option)
check out [callback module documentation](#callback_exports) for details of the callback module interface
@ -393,7 +393,7 @@ encode(Term, Opts) -> JSON
N = pos_integer()
```
`encode` parses a json text (a `utf8` encoded binary) and produces an erlang term
`encode` converts an erlang term into json text (a `utf8` encoded binary)
the option `{space, N}` inserts `N` spaces after every comma and colon in your json output. `space` is an alias for `{space, 1}`. the default is `{space, 0}`