MINOR: [C++][Documentation] Update tutorial docs to include parquet linking gotcha - #50881
MINOR: [C++][Documentation] Update tutorial docs to include parquet linking gotcha#50881devanbenz wants to merge 2 commits into
Conversation
- I was running in to an issue that ended up being solved by: apache#42730 That being said, it would probably be good for novices to parquet and arrow C++ such as myself to have some explicit documentation as part of the tutorial.
|
Thanks for opening a pull request! This pull request has been automatically converted to a draft because its title doesn't match Arrow's required format. If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format? or After updating the title, you can mark the pull request as ready for review. See also: |
There was a problem hiding this comment.
Pull request overview
Updates the C++ tutorial documentation to call out a common “undefined reference” gotcha when using Parquet (and Datasets), by pointing readers to the correct CMake packages/targets to link.
Changes:
- Adds a new “Linking Parquet” section to the C++ build system docs with a complete CMake example.
- Adds notes to the I/O and Datasets tutorials explaining that Parquet (and Dataset) require additional link targets beyond
Arrow::arrow_shared.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/source/cpp/tutorials/io_tutorial.rst | Adds a note clarifying Parquet requires linking Parquet::parquet_shared in addition to Arrow. |
| docs/source/cpp/tutorials/datasets_tutorial.rst | Adds a note about linking Dataset + Parquet targets (and refers to build system docs). |
| docs/source/cpp/build_system.rst | Introduces an anchored “Linking Parquet” section with a complete CMake snippet and target names. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
I was running in to an issue that ended up being solved by: #42730
That being said, it would probably be good for novices to parquet and arrow C++ such as myself to have some explicit documentation as part of the tutorial.