Skip to content

Document protocol schema JSON and binary format#24

Merged
johnstairs merged 11 commits intomainfrom
johnstairs/format-documentation
Dec 9, 2022
Merged

Document protocol schema JSON and binary format#24
johnstairs merged 11 commits intomainfrom
johnstairs/format-documentation

Conversation

@johnstairs
Copy link
Copy Markdown
Member

Documenting the binary format and JSON protocol schema, which is included in the binary and HDF5 formats.

Also making two code changes:

  1. The JSON schema for vectors and arrays was not simplifying the representation of a single type (i.e. not a union) to a single value instead of an array with one element.
  2. Simplified and made more consistent the code to read and write floating point numbers in the binary format.

@johnstairs johnstairs requested a review from hansenms December 5, 2022 17:48
Copy link
Copy Markdown
Contributor

@hansenms hansenms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. If I was to make any comment it would be that at the end of the binary format description, I would actually have and end to end example with simple types and a few datapoints, but maybe we should wait until this has settled down a bit.

@johnstairs
Copy link
Copy Markdown
Member Author

This looks good. If I was to make any comment it would be that at the end of the binary format description, I would actually have and end to end example with simple types and a few datapoints, but maybe we should wait until this has settled down a bit.

@hansenms Great idea. I've added an example here.

@johnstairs johnstairs merged commit 0fd61b0 into main Dec 9, 2022
@johnstairs johnstairs deleted the johnstairs/format-documentation branch December 9, 2022 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants