alamb opened a new pull request, #5786:
URL: https://github.com/apache/arrow-rs/pull/5786
# Which issue does this PR close?
# Rationale for this change
In the context of https://github.com/apache/datafusion/issues/10453 I have
spent a while trying to use the parquet crate's documentation, and I found it
quite confusing.
My real goal is to update the statistics documentation, however, when I
opened the docs pretending I just wanted to use the crate (not check out its
code and know how it worked) there wasn't an obvious way I was even going to
find the statsistics.
Thus I propose cleaning up some of these docs to start.
# What changes are included in this PR?
1. Improve crate lib page to also list parquet metadata and statistics
access as an API
2. Improve documentation on metadata to better explain how they are related
to each other
3. Improve documentation on type structures to try and explain what they do
better
Note this is far from perfect, but I think it is significantly better than
what we have in terms of navigating the crate. I'll keep working on the docs as
follow on PRs
# Are there any user-facing changes?
Better docs
<!--
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]
