From 029407b6af9c1a308eace208a7fc30a97eb197c5 Mon Sep 17 00:00:00 2001 From: Paul-Elliot Date: Thu, 27 Jan 2022 13:28:14 +0100 Subject: [PATCH] review comments Signed-off-by: Paul-Elliot --- doc/index.mld | 11 +++-------- lib/yojson.cppo.mli | 2 +- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/doc/index.mld b/doc/index.mld index 90c19816..4c9b4c5f 100644 --- a/doc/index.mld +++ b/doc/index.mld @@ -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 {{: JSON specification}json specification}. +See {{:http://json.org}JSON specification}. Author: Martin Jambon diff --git a/lib/yojson.cppo.mli b/lib/yojson.cppo.mli index 24381fdf..79a894c2 100644 --- a/lib/yojson.cppo.mli +++ b/lib/yojson.cppo.mli @@ -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.