[jira] [Created] (ARROW-8076) [C++] arrow::stl::TupleRangeFromTable example includes wrong signature

["Tomasz Cheda (Jira)" <ji...@apache.org>]

Tomasz Cheda created ARROW-8076:
-----------------------------------

             Summary: [C++] arrow::stl::TupleRangeFromTable example includes wrong signature
                 Key: ARROW-8076
                 URL: https://issues.apache.org/jira/browse/ARROW-8076
             Project: Apache Arrow
          Issue Type: Bug
          Components: C++, C++ - Compute, Documentation
    Affects Versions: 1.0.0
            Reporter: Tomasz Cheda


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

{color:#b5b6e3}Status {color}{color:#ffc66d}TupleRangeFromTable{color}({color:#cc7832}const {color}{color:#b5b6e3}Table{color}& table{color:#cc7832}, const {color}{color:#b5b6e3}compute{color}::{color:#b5b6e3}CastOptions{color}& cast_options{color:#cc7832},
{color} {color:#b5b6e3}compute{color}::{color:#b5b6e3}FunctionContext{color}* ctx{color:#cc7832}, {color}{color:#b9bcd1}Range{color}* 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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)