Skip to content

MINOR: [C++][Documentation] Update tutorial docs to include parquet linking gotcha - #50881

Open
devanbenz wants to merge 4 commits into
apache:mainfrom
devanbenz:db/docs/file-io-link-parquet
Open

devanbenz wants to merge 4 commits into
apache:mainfrom
devanbenz:db/docs/file-io-link-parquet

Conversation

@devanbenz

Copy link
Copy Markdown

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.

- 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.
Copilot AI lite review requested due to automatic review settings August 15, 2026 21:30
@devanbenz
devanbenz requested a review from pitrou as a code owner August 15, 2026 21:30
@github-actions

Copy link
Copy Markdown

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?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

After updating the title, you can mark the pull request as ready for review.

See also:

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/source/cpp/tutorials/datasets_tutorial.rst Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@devanbenz devanbenz changed the title feat: Update tutorial docs to include parquet linking gotcha MINOR: [C++][Documentation] Update tutorial docs to include parquet linking gotcha Aug 15, 2026
@devanbenz
devanbenz marked this pull request as ready for review August 15, 2026 21:35
Copilot AI review requested due to automatic review settings August 15, 2026 21:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

uros-b
uros-b previously approved these changes Aug 21, 2026
@uros-b

uros-b commented Aug 21, 2026

Copy link
Copy Markdown
Member

+1, thank you @devanbenz!

@thisisnic
thisisnic dismissed uros-b’s stale review September 7, 2026 14:13

Requires committer review

Copilot AI review requested due to automatic review settings September 28, 2026 18:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Static-linking guidance must use matching static Arrow and Parquet targets.

Review effort: Lite
Findings: 1 Medium severity

Open (1)

Comment thread docs/source/cpp/build_system.rst Outdated
Clarify usage of static libraries for Arrow and Parquet.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings September 28, 2026 18:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The sole finding is a minor, non-blocking documentation completeness nit.

Review effort: Lite
Findings: None

Resolved since last review (1)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants