From c111ffc2553b68c83365cca728dadccfdc6bacb5 Mon Sep 17 00:00:00 2001 From: danielaparker Date: Fri, 2 Aug 2019 00:10:38 -0400 Subject: [PATCH] Doc update --- README.md | 10 +++++----- doc/Pages/index.md | 4 ++-- doc/ref/bson/bson.md | 2 +- doc/ref/cbor/cbor.md | 8 ++++---- doc/ref/csv/csv.md | 6 +++--- doc/ref/msgpack/msgpack.md | 2 +- doc/ref/ubjson/ubjson.md | 6 +++--- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index abbf609751..4cdaccba70 100644 --- a/README.md +++ b/README.md @@ -130,13 +130,13 @@ std::string data = R"( jsoncons allows you to work with the data in a number of ways: -- As a variant-like structure, [basic_json](doc/ref/basic_json.md) +- As a variant-like data structure, [basic_json](doc/ref/basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ int main() @@ -465,13 +465,13 @@ const std::vector data = { jsoncons allows you to work with the CBOR data similarly to JSON data: -- As a variant-like structure, [basic_json](doc/ref/basic_json.md) +- As a variant-like data structure, [basic_json](doc/ref/basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ int main() @@ -567,7 +567,7 @@ bar, 50 75 73 73, 1.23456789012345678901234567890 ``` Note that when decoding the bigfloat and decimal fraction into a `std::string`, we lose the semantic information -that the variant like data structure preserved with a tag, so serializing back to CBOR results in a text string. +that the variant like data structure preserved with a tag, so serializing back to CBOR produces a text string. #### As a stream of parse events diff --git a/doc/Pages/index.md b/doc/Pages/index.md index 684398de72..8d04237084 100644 --- a/doc/Pages/index.md +++ b/doc/Pages/index.md @@ -68,13 +68,13 @@ std::string data = R"( jsoncons allows you to work with the data in a number of ways: -- As a variant-like structure, [basic_json](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/basic_json.md) +- As a variant-like data structure, [basic_json](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ diff --git a/doc/ref/bson/bson.md b/doc/ref/bson/bson.md index 86419145e0..ec520ab089 100644 --- a/doc/ref/bson/bson.md +++ b/doc/ref/bson/bson.md @@ -1,7 +1,7 @@ ### bson extension The bson extension implements decode from and encode to the [Binary JSON](http://bsonspec.org/) data format. -You can either parse into or serialize from a variant-like structure, [basic_json](../basic_json.md), or your own +You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). [decode_bson](decode_bson.md) diff --git a/doc/ref/cbor/cbor.md b/doc/ref/cbor/cbor.md index dcbf127b26..27058aa6cd 100644 --- a/doc/ref/cbor/cbor.md +++ b/doc/ref/cbor/cbor.md @@ -1,7 +1,7 @@ ## cbor extension The cbor extension implements decode from and encode to the IETF standard [Concise Binary Object Representation (CBOR)](http://cbor.io/). -You can either parse into or serialize from a variant-like structure, [basic_json](../basic_json.md), or your own +You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). [decode_cbor](decode_cbor.md) @@ -143,13 +143,13 @@ const std::vector data = { jsoncons allows you to work with the CBOR data similarly to JSON data: -- As a variant-like structure, [basic_json](doc/ref/basic_json.md) +- As a variant-like data structure, [basic_json](doc/ref/basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ int main() @@ -245,7 +245,7 @@ bar, 50 75 73 73, 1.23456789012345678901234567890 ``` Note that when decoding the bigfloat and decimal fraction into a `std::string`, we lose the semantic information -that the variant like data structure preserved with a tag, so serializing back to CBOR results in a text string. +that the variant like data structure preserved with a tag, so serializing back to CBOR produces a text string. #### As a stream of parse events diff --git a/doc/ref/csv/csv.md b/doc/ref/csv/csv.md index 54896e42ac..d5cf5baea1 100644 --- a/doc/ref/csv/csv.md +++ b/doc/ref/csv/csv.md @@ -1,7 +1,7 @@ ### csv extension The csv extension implements decode from and encode to the [CSV format](https://www.rfc-editor.org/rfc/rfc4180.txt) -You can either parse into or serialize from a variant-like structure, [basic_json](../basic_json.md), or your own +You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). [decode_csv](decode_csv.md) @@ -35,14 +35,14 @@ EUR_LIBOR_06M,2015-10-27,0.0000001 jsoncons allows you to work with the CSV data similarly to JSON data: -- As a variant-like structure, [basic_json](../basic_json.md) +- As a variant-like data structure, [basic_json](../basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ int main() diff --git a/doc/ref/msgpack/msgpack.md b/doc/ref/msgpack/msgpack.md index 8a337f04a7..aa9811bd7f 100644 --- a/doc/ref/msgpack/msgpack.md +++ b/doc/ref/msgpack/msgpack.md @@ -1,7 +1,7 @@ ### msgpack extension The msgpack extension implements encode to and decode from the [MessagePack](http://msgpack.org/index.html) data format. -You can either parse into or serialize from a variant-like structure, [basic_json](../basic_json.md), or your own +You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). diff --git a/doc/ref/ubjson/ubjson.md b/doc/ref/ubjson/ubjson.md index f14f3efe6d..296a5e8ceb 100644 --- a/doc/ref/ubjson/ubjson.md +++ b/doc/ref/ubjson/ubjson.md @@ -1,7 +1,7 @@ ## ubjson extension The ubjson extension implements encode to and decode from the [Universal Binary JSON Specification](http://ubjson.org/) data format. -You can either parse into or serialize from a variant-like structure, [basic_json](../basic_json.md), or your own +You can either parse into or serialize from a variant-like data structure, [basic_json](../basic_json.md), or your own data structures, using [json_type_traits](../json_type_traits.md). [decode_ubjson](decode_ubjson.md) @@ -60,13 +60,13 @@ const std::vector data = jsoncons allows you to work with the UBJSON data similarly to JSON data: -- As a variant-like structure, [basic_json](doc/ref/basic_json.md) +- As a variant-like data structure, [basic_json](doc/ref/basic_json.md) - As a strongly typed C++ data structure - As a stream of parse events -#### As a variant-like structure +#### As a variant-like data structure ```c++ int main()