docs: add documents to substrait type variation consts #10719
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
Signed-off-by: Ruihang Xia <[email protected]>
alamb
approved these changes
May 30, 2024
There was a problem hiding this comment.
Makes sense to me. Thank you @waynexia for making the code eaiser to read
When I see "var" I often think it is shorthand for "variable" but in this case it is VARIATION
Maybe it would be clearer to name these constants with the full name, something like
DATE_32_TYPE_VAR_REF --> DATE_32_TYPE_VARIATION_REF ?
Though maybe that is too long
cc @Blizzara perhaps you can review this as well?
Blizzara
reviewed
May 30, 2024
| pub const DECIMAL_256_TYPE_REF: u32 = 1; | ||
| // For [type variations](https://substrait.io/types/type_variations/#type-variations) in substrait. | ||
| // Type variations are used to represent different types based on one type class. | ||
| /// The "system-preferred" variation (i.e., no variation). |
There was a problem hiding this comment.
Maybe add here something like a TODO: move the non-system-preferred variations into a SimpleExtension to make it clear that this is not the final form?
Signed-off-by: Ruihang Xia <[email protected]>
Signed-off-by: Ruihang Xia <[email protected]>
|
LGTM! |
findepi
pushed a commit
to findepi/datafusion
that referenced
this pull request
Jul 16, 2024
* docs: add documents to substrait type variation consts Signed-off-by: Ruihang Xia <[email protected]> * rename and add todo Signed-off-by: Ruihang Xia <[email protected]> * fix link style Signed-off-by: Ruihang Xia <[email protected]> --------- Signed-off-by: Ruihang Xia <[email protected]>
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.
Which issue does this PR close?
Closes #.
Rationale for this change
Follow-up of #10646 (comment). Document those type variation consts and link to the corresponding substrait website.
What changes are included in this PR?
This patch also renames
*_TYPE_REFto_TYPE_VAR_REFto distinguish "type reference" for user-defined type and "type variation reference" for type variation.Are these changes tested?
Are there any user-facing changes?