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

Updates explanation of modules #369

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Updates explanation of modules #369

merged 3 commits into from
Dec 2, 2024

Conversation

zslayton
Copy link
Contributor

@zslayton zslayton commented Nov 25, 2024

This PR replaces the singular 'encoding module' model with the new 'encoding module sequence' design. It does not update all of the many examples in the spec that use the old model. I will put together a follow-on PR that addresses those (more mechanical) substitutions.

It also updates some of the text in the "What's New" section to reflect recent developments.


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

For an inner module, it also includes the modules previously made available by the enclosing
module (via `import` or `module`).
* The macro table and symbol table are empty.
Before any clauses of the module definition are examined, each of these is empty.
Copy link
Contributor

Choose a reason for hiding this comment

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

The modules bindings does not contain $ion or _?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's correct. The bindings for $ion and _ are at the stream level. Referencing them inside a module will result in recursive lookups through the parent scopes until it reaches the stream. (Optimizations are possible, of course, but this is the behavior that must be achieved.)

_books/ion-1-1/src/modules/directives.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/modules/directives.md Show resolved Hide resolved
_books/ion-1-1/src/modules/directives.md Show resolved Hide resolved
_books/ion-1-1/src/modules/encoding_modules.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/modules/local_modules.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/modules/shared_modules.md Outdated Show resolved Hide resolved
_books/ion-1-1/src/modules/local_modules.md Outdated Show resolved Hide resolved
@zslayton zslayton marked this pull request as ready for review November 27, 2024 16:46
@zslayton zslayton requested review from popematt and tgregg November 27, 2024 16:46
@zslayton zslayton requested a review from jobarr-amzn November 27, 2024 17:55
Copy link
Contributor

@tgregg tgregg left a comment

Choose a reason for hiding this comment

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

Approved, noting there are a few minor corrections suggested by Matt.

_books/ion-1-1/src/whats_new.md Show resolved Hide resolved
_books/ion-1-1/src/whats_new.md Show resolved Hide resolved
_books/ion-1-1/src/whats_new.md Show resolved Hide resolved
_books/ion-1-1/src/whats_new.md Show resolved Hide resolved
_books/ion-1-1/src/whats_new.md Show resolved Hide resolved
@zslayton zslayton merged commit 6c2598b into gh-pages Dec 2, 2024
1 check passed
@zslayton zslayton deleted the modules branch December 2, 2024 17:31
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