diff options
author | Mark Pulford <mark@kyne.com.au> | 2011-11-29 00:11:22 +1030 |
---|---|---|
committer | Mark Pulford <mark@kyne.com.au> | 2011-11-29 00:11:22 +1030 |
commit | 8e259a73fd2fbf9060e3514cd67eee69ebfb85a7 (patch) | |
tree | fd004f416f75385f1dd06bdca2d3e14621a7284a | |
parent | 11b35407875cc363f7897ff1c7c34828b4efe3ce (diff) | |
download | lua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.tar.gz lua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.tar.bz2 lua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.zip |
Improve README documentation (minor)
-rw-r--r-- | README | 21 |
1 files changed, 10 insertions, 11 deletions
@@ -15,9 +15,8 @@ Features: | |||
15 | 15 | ||
16 | Caveats: | 16 | Caveats: |
17 | - UTF-16 and UTF-32 are not supported. | 17 | - UTF-16 and UTF-32 are not supported. |
18 | - Multiple OS threads within a single Lua state are not currently | 18 | - Multi-threading within a single Lua state is not supported. |
19 | supported. However, this is an extremely uncommon configuration due | 19 | However, this is not a recommended configuration under Lua. |
20 | to performance limitations. | ||
21 | 20 | ||
22 | To obtain the latest version of Lua CJSON visit: | 21 | To obtain the latest version of Lua CJSON visit: |
23 | 22 | ||
@@ -266,15 +265,15 @@ not freed until CJSON is garbage collected. Setting this option to | |||
266 | cjson.encode(). | 265 | cjson.encode(). |
267 | 266 | ||
268 | 267 | ||
269 | Lua / JSON limitations and CJSON | 268 | JSON and handling under Lua CJSON |
270 | ================================ | 269 | ================================= |
271 | 270 | ||
272 | Null handling | 271 | Nulls |
273 | ------------- | 272 | ----- |
274 | 273 | ||
275 | Lua CJSON decodes JSON "null" as a Lua lightuserdata NULL pointer. | 274 | Lua CJSON decodes JSON "null" as a Lua lightuserdata NULL pointer. |
276 | 275 | ||
277 | CJSON provides "cjson.null" as a convenience for comparison. | 276 | As a convenience, "cjson.null" is provided for comparison. |
278 | 277 | ||
279 | 278 | ||
280 | Table keys | 279 | Table keys |
@@ -296,7 +295,7 @@ Metamethods | |||
296 | 295 | ||
297 | Lua CJSON does not use metamethods when serialising tables. | 296 | Lua CJSON does not use metamethods when serialising tables. |
298 | - next() is used to iterate over tables. | 297 | - next() is used to iterate over tables. |
299 | - rawget() is used when iterating over arrays. | 298 | - rawget() is used to iterate over arrays. |
300 | 299 | ||
301 | 300 | ||
302 | Functions, Userdata, Threads | 301 | Functions, Userdata, Threads |
@@ -306,8 +305,8 @@ Lua CJSON will generate an error if asked to serialise Lua functions, | |||
306 | userdata, lightuserdata or threads. | 305 | userdata, lightuserdata or threads. |
307 | 306 | ||
308 | 307 | ||
309 | Locale handling | 308 | Locales |
310 | --------------- | 309 | ------- |
311 | 310 | ||
312 | Lua CJSON uses strtod() and snprintf() to perform numeric conversion | 311 | Lua CJSON uses strtod() and snprintf() to perform numeric conversion |
313 | as they are usually well supported, fast and bug free. | 312 | as they are usually well supported, fast and bug free. |