Skip to content

MINOR: [C++][Parquet] Fix incorrect default in ArrowReaderProperties::set_pre_buffer doc - #49911

Merged
pitrou merged 1 commit into
apache:mainfrom
ArnavBalyan:arnavb/fix-default
May 5, 2026
Merged

MINOR: [C++][Parquet] Fix incorrect default in ArrowReaderProperties::set_pre_buffer doc#49911
pitrou merged 1 commit into
apache:mainfrom
ArnavBalyan:arnavb/fix-default

Conversation

@ArnavBalyan

@ArnavBalyan ArnavBalyan commented May 3, 2026

Copy link
Copy Markdown
Member

Rationale for this change

  • The docs comment on ArrowReaderProperties::set_pre_buffer says default false, but the constructor initializes pre_buffer_(true). The API page at arrow.apache.org/docs/cpp/api/formats.html shows false.
  • Default was changed in a previous pr but comment/doc was not updated

What changes are included in this PR?

  • Updated the default value

Are these changes tested?

  • N/A - Docs

Are there any user-facing changes?

  • Yes

@ArnavBalyan
ArnavBalyan requested a review from wgtmac as a code owner May 3, 2026 08:10
@github-actions

github-actions Bot commented May 3, 2026

Copy link
Copy Markdown

Thanks for opening a pull request!

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}

See also:

@ArnavBalyan

Copy link
Copy Markdown
Member Author

cc @pitrou thanks! :)

@pitrou

pitrou commented May 5, 2026

Copy link
Copy Markdown
Member

Also opened #49923 for the corresponding Python options.

@pitrou pitrou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1, thank you @ArnavBalyan

@pitrou pitrou changed the title [C++][Parquet] Fix incorrect default in ArrowReaderProperties::set_pre_buffer doc MINOR: [C++][Parquet] Fix incorrect default in ArrowReaderProperties::set_pre_buffer doc May 5, 2026
@pitrou
pitrou merged commit a2d8e9c into apache:main May 5, 2026
52 of 54 checks passed
@pitrou pitrou removed the awaiting review Awaiting review label May 5, 2026
@github-actions github-actions Bot added the awaiting committer review Awaiting committer review label May 5, 2026
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 0 benchmarking runs that have been run so far on merge-commit a2d8e9c.

None of the specified runs were found on the Conbench server.

The full Conbench report has more details.

@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit a2d8e9c.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 1 possible false positive for unstable benchmarks that are known to sometimes produce them.

Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…:set_pre_buffer doc (apache#49911)

### Rationale for this change
 - The docs comment on ArrowReaderProperties::set_pre_buffer says `default false`, but the constructor initializes pre_buffer_(true). The API page at arrow.apache.org/docs/cpp/api/formats.html shows false.
 - Default was changed in a previous pr but comment/doc was not updated

### What changes are included in this PR?
  - Updated the default value 
### Are these changes tested?
  - N/A - Docs
### Are there any user-facing changes?
  - Yes

Authored-by: Arnav Balyan <arnavbalyan1@gmail.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
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.

2 participants