Adds chapters on text encoding #381
Conversation
| # Values | ||
|
|
||
| ## Annotations | ||
| In the text format, type annotations are denoted by a [symbol token](symbol-tokens.md) and double-colons preceding any value. |
There was a problem hiding this comment.
We should probably note that e-expressions and expression groups are not values, and cannot be annotated.
There was a problem hiding this comment.
I can mention it, but it's not specific to the text encoding. I tried to keep this mostly focused to the encoding itself.
| Whitespace is insignificant and is only required where necessary to separate tokens, and C-style comments | ||
| (either block or in-line) are treated as whitespace (and are not part of the binary encoding). | ||
|
|
||
| A text Ion 1.1 stream begins with the Ion 1.1 [version marker](../todo.md) (`$ion_1_1`) followed by a series of |
There was a problem hiding this comment.
In the binary section I think I linked to the glossary for "Ion version marker". Do you think it needs its own page or section somewhere?
There was a problem hiding this comment.
I think we need a section that defines the semantics of an Ion stream. By that I mean a chapter that covers things like IVMs, system values vs user values, and $ion_literal.
| [ 1 , two ] // List of an int and a symbol | ||
| [a , [b]] // Nested list | ||
| [ 1.2, ] // Trailing comma is legal in Ion (unlike JSON) | ||
| [ 1, , 2 ] // ERROR: missing element between commas |
There was a problem hiding this comment.
Maybe throw in an example that has a nested e-expression?
Issue #, if available:
N/A
Description of changes:
Adds chapters about the text encoding to the Ion 1.1 specification. They are mostly lifted (with some editing and rearranging) from parts of the Ion 1.0 spec, but has an added section on E-expressions.
See it here: https://popematt.github.io/ion-docs/books/ion-1-1/text/encoding.html
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.