Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation for parquet parse_metadata, decode_metadata and decode_footer #5781

Merged
merged 1 commit into from
May 17, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 17, 2024

Which issue does this PR close?

Closes #.

Rationale for this change

In the context of apache/datafusion#10453 I spent some more time working with the parquet statistics structures in this crate, and I have always found it a little confusing to navigate given the multiple types of statistics involved in parquet

Improving the docs is always a win in my opinion

What changes are included in this PR?

  1. Fix the docs for formatting and correctness

Here is what they looked like before:

Screenshot 2024-05-17 at 10 46 16 AM

And now
Screenshot 2024-05-17 at 10 58 19 AM

Are there any user-facing changes?

///
/// # I/O
///
/// This method first reads the last 8 bytes of the file via
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IO description previously was just incorrect

@github-actions github-actions bot added the parquet Changes to the parquet crate label May 17, 2024
@tustvold tustvold merged commit 28c1cae into apache:master May 17, 2024
16 checks passed
@alamb alamb deleted the alamb/doc_parse_footer branch May 20, 2024 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants