Minor: update documentation for PrunableStatistics #16213
Merged
+20
−8
Conversation
This file contains hidden or 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
commented
May 30, 2025
| /// vectors represent the containers. | ||
| /// The order must match the order of the partition columns in | ||
| /// [`PartitionPruningStatistics::partition_schema`]. | ||
| /// |
There was a problem hiding this comment.
this was a driveby cleanup -- to add some whitespace for my whitespace OCD
alamb
commented
May 30, 2025
|
|
||
| /// Prune a set of containers represented by their statistics. | ||
| /// Each [`Statistics`] represents a container (e.g. a file or a partition of files). | ||
| /// |
There was a problem hiding this comment.
This is the real change of the PR -- to reword this description to try and make it easier to understand
adriangb
approved these changes
May 30, 2025
comphead
approved these changes
May 30, 2025
xudong963
reviewed
Jun 3, 2025
Comment on lines
+268
to
+273
| /// It is up to the caller to decide what each container represents. For | ||
| /// example, they can come from a file (e.g. [`PartitionedFile`]) or a set of of | ||
| /// files (e.g. [`FileGroup`]) | ||
| /// | ||
| /// [`PartitionedFile`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.PartitionedFile.html | ||
| /// [`FileGroup`]: https://docs.rs/datafusion/latest/datafusion/datasource/physical_plan/struct.FileGroup.html |
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?
Rationale for this change
Implement suggestions from @xudong963: #16139 (comment)
What changes are included in this PR?
Tweak the docs a bit
Are these changes tested?
Are there any user-facing changes?