alamb opened a new pull request, #6202: URL: https://github.com/apache/arrow-rs/pull/6202
# Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> Closes #. # Rationale for this change @adrianb added `ParquetMetadataWriter` in https://github.com/apache/arrow-rs/pull/6197 but the documentation was on `ThriftMetadataWriter`. I also think this is a very important API and thus deserves special attention to documentation # What changes are included in this PR? This PR sdds some documentation / examples (which also ensure the code compiles and can be used by crate users), and makes a few tweaks: 1. remove unused `ParquetMetadataWriter::write_page_index` (the page index is written based on its presence) 2. Changes `ParquetMetadataWriter::finish(&mut self)` to `ParquetMetadataWriter::finish(mut self)` so it can be used without being `mut` note I did the changes in two commits so it is clearer what I changed. * the first commit just moves the code with no changes * the second commit adds docs, examples, does some test cleanup, etc # Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!--- If there are any breaking changes to public APIs, please add the `breaking change` label. --> -- 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]
