[Docs][Format] Make Variant value field mandatory
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Open docs/source/format/CanonicalExtensions.rst at the referenced line and compare its Variant wording with parquet-format PR #591 and the linked VariantShredding arrays guidance. Update the text to describe the required fields separately for top-level groups, shredded object fields, and list elements, then verify each level matches the referenced Parquet requirements.
Written by the indexing model from the issue text.
Description
Describe the enhancement requested
Fix wording in the Arrow Variant spec to make the value field mandatory.
https://github.com/apache/arrow/blob/f10c93c000775c5fb30ca230f540358611091589/docs/source/format/CanonicalExtensions.rst?plain=1#L448
Per the conversation in https://github.com/apache/parquet-format/pull/591#issuecomment-4897543546
Note the requirement is level-dependent in the Parquet spec, so the Arrow wording should mirror it level by level rather than making value mandatory everywhere:
- top-level variant group:
valuemust be present - shredded object fields: the field group contains both
valueandtyped_value - list elements:
valuemay be omitted when shredding elements as a specific type, but at least one of the two fields must be present
Component(s)
Format
- Dominant language
- C++
- Stars
- 17.1k
- Forks
- 4.3k
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 93
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/arrow
-
Component: Continuous Integration Component: MATLAB Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Component: C++ Component: Parquet Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Component: C++ Component: Parquet
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Component: C++ Type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Component: Archery Component: Continuous Integration Component: Developer Tools Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·