luo980/json
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse Source 
Signed-off-by: chirsz-ever <chirsz@foxmail.com>
This commit is contained in:
chirsz-ever 2025-01-27 18:51:06 +08:00
parent 44a50e7e2a
commit 86d28891f5
No known key found for this signature in database
GPG Key ID: BB786151F7D070DC
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1767,7 +1767,7 @@ However, you can set set parameter `ignore_comments` to true in the `parse` func
### Trailing commas ### Trailing commas
Trailing commas in arrays and objects are also not part of the [JSON specification](https://tools.ietf.org/html/rfc8259), and this library does not support it by default. The JSON specification does not allow trailing commas in arrays and objects, and hence this library is treating them as parsing errors by default.
Like comments, you can set parameter `ignore_trailing_commas` to true in the `parse` function to ignore trailing commas in arrays and objects. Note that a single comma as the only content of the array or object (`[,]` or `{,}`) is not allowed, and multiple trailing commas (`[1,,]`) are not allowed either. Like comments, you can set parameter `ignore_trailing_commas` to true in the `parse` function to ignore trailing commas in arrays and objects. Note that a single comma as the only content of the array or object (`[,]` or `{,}`) is not allowed, and multiple trailing commas (`[1,,]`) are not allowed either.

2
docs/mkdocs/docs/api/basic_json/accept.md
View File

@ -53,7 +53,7 @@ Unlike the [`parse()`](parse.md) function, this function neither throws an excep
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`ignore_trailing_commas` (in) `ignore_trailing_commas` (in)
: whether trailing commas in arrays or objects should be allowed (`#!cpp true`) or yield a parse error : whether trailing commas in arrays or objects should be ignored and treated like whitespace (`#!cpp true`) or yield a parse error
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`first` (in) `first` (in)

2
docs/mkdocs/docs/api/basic_json/parse.md
View File

@ -59,7 +59,7 @@ static basic_json parse(IteratorType first, IteratorType last,
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`ignore_trailing_commas` (in) `ignore_trailing_commas` (in)
: whether trailing commas in arrays or objects should be allowed (`#!cpp true`) or yield a parse error : whether trailing commas in arrays or objects should be ignored and treated like whitespace (`#!cpp true`) or yield a parse error
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`first` (in) `first` (in)

2
docs/mkdocs/docs/api/basic_json/sax_parse.md
View File

@ -68,7 +68,7 @@ The SAX event lister must follow the interface of [`json_sax`](../json_sax/index
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`ignore_trailing_commas` (in) `ignore_trailing_commas` (in)
: whether trailing commas in arrays or objects should be allowed (`#!cpp true`) or yield a parse error : whether trailing commas in arrays or objects should be ignored and treated like whitespace (`#!cpp true`) or yield a parse error
(`#!cpp false`); (optional, `#!cpp false` by default) (`#!cpp false`); (optional, `#!cpp false` by default)
`first` (in) `first` (in)