Adds sections on modules #353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zslayton
reviewed
Oct 17, 2024
Co-authored-by: Zack Slayton <[email protected]>
tgregg
reviewed
Oct 17, 2024
|
|
||
| ### `macro_table` | ||
|
|
||
| Macros are declared after symbols. |
There was a problem hiding this comment.
Is there a specific reason for this ordering? Food for thought: if symbols were declared after macros, would that make it clearer that the symbols defined in an encoding directive are not yet available for use in the macro definitions in that same encoding directive?
| Macro names are optional, and improve legibility when using, writing, and debugging macros. | ||
| When a name is used, it must be an identifier per Ion’s syntax for symbols. | ||
| Macro definitions being added to the macro table must have a unique name. | ||
| If a macro is added whose name conflicts with one already present in the table, the implementation must raise an error. |
There was a problem hiding this comment.
Except for the system macros, which may be shadowed?
There was a problem hiding this comment.
They can only be shadowed in the sense that a system macro make_string can exist in the system macro table at the same time as a user macro make_string can exist in any other macro table. However, it is never legal to have two macros given the same name in the same macro table, even if one is a system macro.
tgregg
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Adds sections for modules in general and the various types of modules.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.