Skip to content

Commit d53e048

Browse files
authored
Merge pull request #29 from Parquery/radam/patch
Applied fixes from Ledi
2 parents fa4f65f + 9b0a19d commit d53e048

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ among each other -- instead of object trees we needed **object graphs**.
3434

3535
Moreover, we wanted the serialization itself to be **readable** so that an
3636
operator can edit it using a simple text editor. JSONable structure offered
37-
itself as a good fit there with a lot of existing assistance tools (JSON and
37+
itself as a good fit with a lot of existing tools (JSON and
3838
YAML modules *etc*.).
3939

4040
However, JSON allows only a limited set of data types (numbers, strings, arrays
4141
and objects/maps). We found that most of our data relied on
42-
**a richer set of primitives** than was provided by a standard JSON. This
42+
**a richer set of primitives** than provided by standard JSON. This
4343
extended set includes:
4444

4545
* date,
@@ -65,13 +65,13 @@ for object graphs from JSONable structures.
6565

6666
The **schema** of the object graph is stored in a separate JSON file and defines
6767
all the data types used in the object graph including the object graph itself.
68-
The code is generated based on the schema. You define schema once and
69-
generate code in all the supported languages automatically. Schemas can be
68+
The code is generated based on the schema. You define the schema once and
69+
generate code in all supported languages automatically. Schemas can be
7070
evolved and backward compatibility is supported through optional properties.
7171

7272
Supported languages
7373
-------------------
74-
Currently, Mapry speaks:
74+
Currently, Mapry implements the following language bindings:
7575

7676
* C++11,
7777
* Go 1 and
@@ -96,13 +96,13 @@ found `here <https://mapry.readthedocs.io/en/latest/>`_.
9696
Introduction
9797
============
9898

99-
Let us introduce Mapry here by presenting a short example to give you a first
100-
impression how to use the generator. To get the full picture, please consult the
99+
Let us introduce Mapry here by presenting a short example in order to give you a first
100+
impression on how the generator can be used. To get the full picture, please consult the
101101
`documentation <https://mapry.readthedocs.io/en/latest/>`__.
102102

103103
The schema starts with the name and a description, followed by the
104104
language-specific settings (specifying the non-standard parts of the code
105-
generation), defines the graph structures and finally defines the properties of
105+
generation), the definition of the graph structure and finally the definition of the properties of
106106
the object graph itself.
107107

108108
Here is an example schema to give you an overview:
@@ -232,15 +232,15 @@ and access the object graph as ``pipeline``:
232232
pipeline.maintainer.id))
233233
234234
235-
The full generated code for this schema is available in
235+
The generated code for this schema can be downloaded for
236236
`C++ <https://github.com/Parquery/mapry/blob/master/test_cases/docs/schema/introductory_example/cpp/test_generate>`_,
237237
`Go <https://github.com/Parquery/mapry/blob/master/test_cases/docs/schema/introductory_example/py/test_generate>`_ and
238238
`Python <https://github.com/Parquery/mapry/blob/master/test_cases/docs/schema/introductory_example/py/test_generate>`_.
239239

240240
Usage
241241
=====
242242

243-
Mapry provides a single point-of-entry for all the code generation through
243+
Mapry provides a single point-of-entry for all code generation through
244244
``mapry-to`` command.
245245

246246
To generate the code in different languages, invoke:
@@ -320,11 +320,11 @@ De/serializers based on annotations
320320
`Jackson in Java <https://github.com/FasterXML/jackson>`_). Since they are
321321
based on annotations in source code, a polyglot code base would require
322322
a duplication across different languages which can be cumbersome and
323-
error-prone to synchronize.
323+
error-prone to keep synchronized.
324324

325325
Standard or widely used serialization libraries
326-
handle well object graphs and rich set of primitives. However, it would be
327-
very difficult to keep up the serialization format across languages (*e.g.*,
326+
handle object graphs well and provide a rich set of primitives. However, the serialization
327+
format differs accross languagues (*e.g.*,
328328
`Boost.Serialization in C++ <https://www.boost.org/doc/libs/1_70_0/libs/serialization/doc/index.html>`_
329329
or `Pickle in Python <https://docs.python.org/3/library/pickle.html>`_
330330
would need to be supported in Go).
@@ -335,5 +335,5 @@ Popular serializers based on generated code
335335
`Cap'n Proto <https://capnproto.org/>`_).
336336

337337
`Flatbuffers <https://google.github.io/flatbuffers/>`_ being the exception
338-
handle object graphs natively, but lack support sophisticated types such as
338+
handle object graphs natively, but lack support for sophisticated types such as
339339
maps and datetimes, durations *etc.*

0 commit comments

Comments
 (0)