Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Dec 1, 2023

Which issue does this PR close?

Related to #8376

Rationale for this change

As part of #8376 I have been rereading the code and familiarizing myself with how it works, which I wanted to include as comments for the future.

Since this doesn't make any code changes, I broke it into its own PR for easier review

What changes are included in this PR?

Update doc comments

Are these changes tested?

N/A

Are there any user-facing changes?

Better documentation, no functional changes

@github-actions github-actions bot added the core Core DataFusion crate label Dec 1, 2023
@alamb alamb marked this pull request as ready for review December 1, 2023 14:02
@alamb alamb added documentation Improvements or additions to documentation devrel labels Dec 1, 2023
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Dec 1, 2023
/// known from external catalogs (e.g. Delta Lake) or other sources. Thus it
/// supports:
///
/// 1. Arbitrary expressions expressions (including user defined functions)
Copy link
Member

Choose a reason for hiding this comment

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

This is not changed by this PR, but is expressions repeated?

Suggested change
/// 1. Arbitrary expressions expressions (including user defined functions)
/// 1. Arbitrary expressions (including user defined functions)

@alamb
Copy link
Contributor Author

alamb commented Dec 3, 2023

Thank you for the review @viirya and @Dandandan

Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
@alamb alamb merged commit d1554c8 into apache:main Dec 5, 2023
@alamb alamb deleted the alamb/pruning_predicate_docs branch December 5, 2023 01:26
appletreeisyellow pushed a commit to appletreeisyellow/datafusion that referenced this pull request Dec 15, 2023
* Minor: Improve PruningPredicate documentation

* tweaks

* Apply suggestions from code review

Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>

---------

Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants