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.

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

Adds glossary and consolidates grammar #359

Merged
merged 7 commits into from
Oct 31, 2024

Conversation

popematt
Copy link
Contributor

Issue #, if available:

Description of changes:

  • Consolidates the macro and module grammar
  • Adds a glossary
  • Fixes some typos in defining_macros.md and adds a missing link
  • Drive by fix of the Ion 1.0 spec to clarify that keywords (true, false, null, nan) are not identifier symbols.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@popematt popematt requested a review from zslayton October 18, 2024 13:26
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Show resolved Hide resolved

**segment**<br/>
A contiguous partition of a _document_ that uses the same _active encoding module_. Segment boundaries
are caused by directives: an IVM starts a new segment, while `$ion_symbol_table` and `$ion_encoding`
Copy link
Contributor

Choose a reason for hiding this comment

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

An IVM ends the previous segment (if any) and starts a new one, correct?

_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Show resolved Hide resolved
Copy link
Contributor

@zslayton zslayton left a comment

Choose a reason for hiding this comment

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

Looks good, a few small comments that can be TODOs

Comment on lines +3 to +5
**active encoding module**<br/>
The _encoding module_ whose symbol table and macro table are available in the current _segment_ of an Ion _document_.
The active encoding module is set by a _directive_.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thinking out loud, it would be really nice to incorporate something like this pre-processor to make phrases in the spec show their definition on hover.

Having a glossary is great, but not having to leave the page to define a term would be even better.

EDIT: I just saw that preprocessor's first and only issue. 😆

_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/glossary.md Outdated Show resolved Hide resolved
@popematt popematt merged commit e5e02a5 into amazon-ion:gh-pages Oct 31, 2024
1 check passed
@popematt popematt deleted the glossary branch October 31, 2024 22:25
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.

3 participants