apache / apache/arrow

[C++][Docs] Verify Completeness of API Reference

Open
#32,481 2 comments 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Type: task
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

At least the Datum class is missing methods in the API documentation, and any other incompleteness needs to be found and addressed. This ticket is for hunting down incompleteness, and filling in the gaps.

**Reporter**: [Kae Suarez](https://issues.apache.org/jira/browse/ARROW-17186) / @ksuarez1423
#### Related issues:
- [[Docs][C++] Add missing methods to ArrayBuilders API Reference](https://github.com/apache/arrow/issues/32617) (is a parent of)

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

Contributor guide

Open the contributing guide

Research direction

Start by comparing the C++ API documentation with the public methods of the Datum class, then check whether other documented APIs have similar gaps. The related ArrayBuilders API Reference issue may help identify the documentation area and expected coverage. Done means all missing API methods are documented and the completeness gaps found by the audit are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.