Skip to content

[C++] arrow::stl::TupleRangeFromTable docs incorrect #17081

@asfimport

Description

@asfimport

The docs at https://github.com/apache/arrow/blob/master/docs/source/cpp/examples/tuple_range_conversion.rst use TupleRangeFromTable as

arrow::stl::TupleRangeFromTable(*table, &rows)

while the real signature is

Status TupleRangeFromTable(const Table& table, const compute::CastOptions& cast_options,
compute::FunctionContext* ctx, Range* rows)

No explanation is offered as to what the extra arguments are. No such comments can be found in the relevant source code, either. Github history shows that this has been the case since this function was added by @xhochy , who also authored the docs.

This issue needs to be addressed by somebody with enough familiarity with the related code to rewrite the doc.

Reporter: Tomasz Cheda

Note: This issue was originally created as ARROW-8076. Please see the migration documentation for further details.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions