Minor: Improve PruningPredicate documentation
#7738
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
alamb
changed the title
PruningPredicate documentation
mhilton
approved these changes
Oct 4, 2023
jackwener
approved these changes
Oct 8, 2023
|
Thank you @jackwener |
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?
N/A
Rationale for this change
We make use of the PruningPredicate a lot in IOx and I think it is a powerful feature. However, it is hard to explain to people / refer them to docs about it.
I would like to make it easier to understand by reading the docs
What changes are included in this PR?
Improve the docs for PruningPredicate, clarifying the rationale as well as adding some examples
Are these changes tested?
By doc tests
Are there any user-facing changes?
Better docs. No code changes