docs: document all fields and methods of DFParquetMetadata - #24037
Open
alamb wants to merge 3 commits into
Open
Conversation
Add doc comments to every field and method on DFParquetMetadata, linking to the corresponding arrow-rs ParquetMetaDataReader APIs where behavior mirrors it (prefetch hint, decryption properties, page index policy, page index loading).
alamb
force-pushed
the
alamb/dfparquetmetadata-docs
branch
from
July 31, 2026 21:53
0e4b117 to
896c1e7
Compare
alamb
changed the title
DFParquetMetadata
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24037 +/- ##
==========================================
- Coverage 80.88% 80.87% -0.01%
==========================================
Files 1102 1102
Lines 375813 375813
Branches 375813 375813
==========================================
- Hits 303971 303951 -20
- Misses 53741 53752 +11
- Partials 18101 18110 +9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
nuno-faria
approved these changes
Aug 2, 2026
Comment on lines
243
to
252
| @@ -203,10 +251,20 @@ impl<'a> DFParquetMetadata<'a> { | |||
| }) | |||
| } | |||
Contributor
There was a problem hiding this comment.
nit: What do you think about adding a small phrase about why the default is retrieving it? Something like "when page_index_policy is not set but there is a cache available, the page index is retrieved to improve the probability of cache hits in future reads" or something along those lines.
Contributor
Author
There was a problem hiding this comment.
That is a great idea -- I pushed an update in 5a6ad50 -- what do you think?
github-actions
Bot
removed
the
documentation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
ParquetFileReaderandCachedParquetFileReader#24036Rationale for this change
DFParquetMetadatahad several fields and methods with no doc comments, or only a one-line description, making it hard to understand their purpose without reading the implementation.What changes are included in this PR?
Add doc comments
Are these changes tested?
No behavior changed, only doc comments were added; existing tests cover the code.
Are there any user-facing changes?
No functional changes; public API doc comments are improved.