Skip to content

Improve documentation and add examples for ArrowPredicateFn#7480

Merged
alamb merged 1 commit into
apache:mainfrom
alamb:alamb/doc_predicate_fn
May 9, 2025
Merged

Improve documentation and add examples for ArrowPredicateFn#7480
alamb merged 1 commit into
apache:mainfrom
alamb:alamb/doc_predicate_fn

Conversation

@alamb

@alamb alamb commented May 7, 2025

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

  • While working on Add arrow_reader_clickbench benchmark #7470 it took me some time to work out how to use ArrowPredicateFn. I would like to make it easier for my future self. I also plan to publicize this API more over the next few months so having clear documentation is a good thing

What changes are included in this PR?

Improve documentation and add examples for ArrowPredicateFn

Are there any user-facing changes?

Documentation only, no functional changes

@alamb alamb added the documentation Improvements or additions to documentation label May 7, 2025
@github-actions github-actions Bot added the parquet Changes to the parquet crate label May 7, 2025

@phillipleblanc phillipleblanc 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.

Thanks for working on this! I happened to run into ArrowPredicateFn while working on an issue in the iceberg-rust crate, and this is helpful for understanding it.

@alamb

alamb commented May 9, 2025

Copy link
Copy Markdown
Contributor Author

Thank you for the review @phillipleblanc

@alamb alamb merged commit 8fb2270 into apache:main May 9, 2025
16 checks passed
@alamb alamb deleted the alamb/doc_predicate_fn branch May 9, 2025 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation parquet Changes to the parquet crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants