Updates system macro descriptions #368
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
approved these changes
Nov 22, 2024
Co-authored-by: Zack Slayton <[email protected]>
Co-authored-by: Zack Slayton <[email protected]>
jobarr-amzn
approved these changes
Nov 22, 2024
Comment on lines
281
to
292
| Produces a non-null, unannotated timestamp at various levels of precision. | ||
| When `offset` is absent, the result has unknown local offset; offset `0` denotes UTC. | ||
|
|
||
| The arguments to this macro may not be any null value. | ||
| The evaluated argument for the `second` parameter, if present, must be a decimal or integer value that is greater than | ||
| or equal to zero and less than 60. The evaluated arguments for all other parameters, if present, must be integer values. | ||
|
|
||
| The `make_timestamp` macro has additional rules (that cannot be expressed in the macro signature) because it must | ||
| construct a valid Ion timestamp value. | ||
| The `offset_minutes` and `hour` parameters may only be present if `minute` is present. Aside from `offset_minutes`, if | ||
| any evaluated argument is present, the evaluated arguments for all parameters to the left must also be present. | ||
| The precision of the constructed timestamp is determined by which parameters have non-empty arguments. |
There was a problem hiding this comment.
Why specify the range constraints for second but not for day, month, or hour?
Secondly, could one not default unspecified parameters to 0? Or should that be left up to the user to define such macros if they are useful?
There was a problem hiding this comment.
Why specify the range constraints for second but not for day, month, or hour?
I'll update the description.
Secondly, could one not default unspecified parameters to 0?
Well, that already happens (somewhat) because of timestamp semantics. E.g. these macro invocations all represent the same point in time, but with different precisions.
(:make_timestamp 2024 12)
(:make_timestamp 2024 12 1)
(:make_timestamp 2024 12 1 0 0)
(:make_timestamp 2024 12 1 0 0 0)
(:make_timestamp 2024 12 1 0 0 0.000)
tgregg
approved these changes
Nov 22, 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:
None.
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.