apache / apache/arrow

[C++] Fix documentation on Newly Added Methods on ExecPlan

Open
#33,649 2 comments 0 reactions 0 assignees View on GitHub
Component: C++ Type: bug
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

### Describe the bug, including details regarding any error messages, version, and platform.

We see the following error in the CIs : https://github.com/apache/arrow/pull/33623#issuecomment-1381326714

```bash
/arrow/cpp/src/arrow/compute/exec/exec_plan.h:427: error: The following parameter of arrow::compute::DeclarationToTable(Declaration declaration, bool use_threads=true, MemoryPool *memory_pool=default_memory_pool(), FunctionRegistry *function_registry=NULLPTR) is not documented:
parameter 'declaration' (warning treated as error, aborting now)
```

### Component(s)

C++

Contributor guide

Open the contributing guide

Research direction

Inspect cpp/src/arrow/compute/exec/exec_plan.h around line 427 and compare the DeclarationToTable documentation with its declaration parameter list. Ensure the declaration parameter is documented, then rerun the documentation check or CI that reported the warning and confirm it no longer treats this error as fatal.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.