Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation updates #79

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Small documentation updates #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1e6478
Address #69
johnstairs Oct 17, 2023
0756d60
Address #68
johnstairs Oct 17, 2023
59d78d4
Fix missing word
johnstairs Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/reference/binary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Compact Binary Encoding Reference

The details of the binary encoding format are provided here for reference. You
do not need to be familiar with this in order to use Yardl, as it takes care of
serialization and deserialization for you. To learn about the semantics of the
data types and how to use them, refer to the [Python](../python/language.md) or
[C++](../cpp/language.md) language guides.

::: warning
We might make breaking changes to this format before V1.
:::
Expand Down Expand Up @@ -141,12 +147,12 @@ The format is:

Enums and flags are written as a varint encoding of the underlying integer
value. Note that the value is signed if the underlying type is signed, which is
the default case if the `base` properly is not specified.
the default case if the `base` property is not specified.

## Records

Records are encoded as the concatenation of the value of its fields, in the
order they appear in the schema.
order they appear in the schema. Note that there is no padding between fields.

## Streams

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/ndjson.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# NDJSON Encoding Reference

The details of the NDJSON encoding format are provided here for reference. You
do not need to be familiar with this in order to use Yardl, as it takes care of
serialization and deserialization for you. To learn about the semantics of the
data types and how to use them, refer to the [Python](../python/language.md) or
[C++](../cpp/language.md) language guides.

::: warning
We might make breaking changes to this format before V1.
:::
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/protocol-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Protocol Schema JSON

A protocol's schema is embedded in a JSON format in the binary, HDF5, and NDJSON
encodings. This JSON format is informally described here.
encodings. This JSON format is informally described here. You do not need to be
familiar with this in order to use Yardl.

::: warning
We might make breaking changes to this format before V1.
Expand Down
Loading