Skip to content

Commit

Permalink
review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Paul-Elliot <[email protected]>
  • Loading branch information
panglesd committed Jan 27, 2022
1 parent 2e9292d commit 029407b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
11 changes: 3 additions & 8 deletions doc/index.mld
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
{0 The [yojson] library}

The Yojson library provides runtime functions for reading and writing JSON
data from OCaml. It addresses a few shortcomings of its predecessor
json-wheel and is about twice as fast (2.7x reading, 1.3x writing; results
may vary).
data from OCaml.
The design goals of Yojson are the following:
- Reducing inter-package dependencies by the use of polymorphic
variants for the JSON tree type.
- Allowing type-aware serializers/deserializers
to read and write directly without going through a generic JSON tree,
for efficiency purposes.
Readers and writers of all JSON syntaxic elements are provided
but are undocumented and meant to be used by generated OCaml code.
- Distinguishing between ints and floats.
- Providing optional extensions of the JSON syntax.
These extensions include comments, arbitrary strings,
optional quotes around field names, tuples and variants.
- Eventually supporting the {{:https://json5.org}JSON5} standard

See {{:<http://json.org> JSON specification}json specification}.
See {{:http://json.org}JSON specification}.

Author: Martin Jambon

Expand Down
2 changes: 1 addition & 1 deletion lib/yojson.cppo.mli
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- The {{!basic}Basic} JSON type,
- The {{!safe}Safe} JSON type, a superset of JSON with safer support for integers,
- The {{!raw}Raw} JSON type, a superset of JSON, safer but less integrated with ocaml types.
- The {{!raw}Raw} JSON type, a superset of JSON, safer but less integrated with OCaml types.
Each of these different types have their own module.
Expand Down

0 comments on commit 029407b

Please sign in to comment.