Minor: Improve PruningPredicate documentation
#8394
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
removed
the
documentation
Dandandan
approved these changes
Dec 2, 2023
viirya
reviewed
Dec 2, 2023
viirya
reviewed
Dec 2, 2023
viirya
reviewed
Dec 2, 2023
| /// The `PruningPredicate` API is general, allowing it to be used for pruning | ||
| /// other types of containers (e.g. files) based on statistics that may be | ||
| /// known from external catalogs (e.g. Delta Lake) or other sources. Thus it | ||
| /// supports: | ||
| /// | ||
| /// 1. Arbitrary expressions expressions (including user defined functions) |
There was a problem hiding this comment.
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) |
viirya
reviewed
Dec 2, 2023
viirya
approved these changes
Dec 2, 2023
|
Thank you for the review @viirya and @Dandandan |
Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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