Fix documentation for parquet parse_metadata, decode_metadata and decode_footer
#5781
Conversation
This file contains 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
… `decode_footer`
alamb
commented
May 17, 2024
| /// | ||
| /// # I/O | ||
| /// | ||
| /// This method first reads the last 8 bytes of the file via |
There was a problem hiding this comment.
The IO description previously was just incorrect
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
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?
Here is what they looked like before:
And now
Are there any user-facing changes?