apache / apache/arrow

[C++] [Documentation] add discussion of Union.typeIds to Layout.rst

Open
#22,342 1 comment 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Status: needs champion Type: bug
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

Union.typeIds is poorly documented and the corresponding property in UnionType is confusingly named type_codes. In particular, Layout.rst doesn't include an explanation of Union.typeIds and implies that an element of a union array's type_ids buffer is always the index of a child array.

**Reporter**: [Ben Kietzman](https://issues.apache.org/jira/browse/ARROW-5933) / @bkietz

**Note**: *This issue was originally created as [ARROW-5933](https://issues.apache.org/jira/browse/ARROW-5933). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.