alamb opened a new pull request, #24037: URL: https://github.com/apache/datafusion/pull/24037
## Which issue does this PR close? - N/A, purely documentation ## Rationale for this change `DFParquetMetadata` had 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? Adds a 2-3 sentence doc comment to every field and method of `DFParquetMetadata`, linking to the corresponding [`ParquetMetaDataReader`](https://docs.rs/parquet/latest/parquet/file/metadata/struct.ParquetMetaDataReader.html) methods in arrow-rs where the behavior mirrors it (`with_prefetch_hint`, `with_decryption_properties`, `with_page_index_policy`, `new_with_metadata`/`load_page_index`, `try_load`). ## 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. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
