Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alavrik committed Sep 11, 2018
1 parent 00899a2 commit 45e760e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/piqi-ocaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,14 +411,14 @@ OCaml types to Piqi types.
will be set to the default value during deserialization. Also, see
[Limitations](#limitations) section below.

**optional** Piqi fields without type (i.e. *flags*) are mapped to `bool`
OCaml fields. The value of the field will be set to `true` if the flag is
present in the record.

**repeated** Piqi fields of type `<t>` are mapped to fields with type
`<t> list`. It is possible to use OCaml `array` instead of `list` by
specifying an additional `.ocaml-array` property in the field definition.

It is possible for some fields to generate OCaml definitions but exclude
them during serialization/deserialization. This is achieved by adding
`.internal` flag under `.field [ ... ]`.

- Enums and Variants are mapped directly to OCaml polymorphic variants.

For example, these definitions:
Expand Down

0 comments on commit 45e760e

Please sign in to comment.