Fix errors and inconsistencies in Variant format documentation#574
Open
iemejia wants to merge 1 commit into
Open
Fix errors and inconsistencies in Variant format documentation#574iemejia wants to merge 1 commit into
iemejia wants to merge 1 commit into
Conversation
VariantEncoding.md:
- Fix BINARY -> BYTE_ARRAY (BINARY is not a Parquet physical type)
- Add note on decimal little-endian vs big-endian difference
- Fix decimal implied-precision formula for val <= 0
- Label undocumented reserved bits in metadata/object/array headers
- Make sorted_strings description consistent across three definitions
- Use INT(N, true) notation consistent with LogicalTypes.md
- Hyphenate compound adjectives ("3 byte" -> "3-byte", etc.)
VariantShredding.md:
- Fix Python syntax error: iterating dict yields keys only;
add .items() for (name, field) unpacking
- Replace BINARY with BYTE_ARRAY
- Fix comma -> colon inside JSON-like literal in table cell
- Remove trailing space inside backticks in table header
- Use INT(N, true) notation consistent with LogicalTypes.md
This file contains hidden or 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
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.
Summary
Fix bugs, terminology errors, and inconsistencies in the Variant format specification documents.
Changes
VariantEncoding.md
sorted_stringsdescription consistent across three definitionsINT(N, true)notation consistent with LogicalTypes.mdVariantShredding.md
.items()for (name, field) unpackingINT(N, true)notation consistent with LogicalTypes.mdValidation
No semantic/behavioral changes to the format specification. All fixes are documentation-only.
Split from #572 for easier review.