Update parquet crate documentation and examples #1253
Merged
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
github-actions
bot
added
arrow
tustvold
reviewed
Feb 1, 2022
| //! | ||
| //! use parquet::arrow::ParquetRecordBatchStreamBuilder; | ||
| //! | ||
| //! # fn assert_batches_eq(batches: &[RecordBatch], expected_lines: &[&str]) { |
There was a problem hiding this comment.
TIL that you can hide doc code using # 👍
|
Sadly, the link to the async reader doc doesn't seem to work on docs.rs: #1307 |
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.
Builds on #1154 so draft until that is mergedWhich issue does this PR close?
Re #111
Rationale for changes
The docs.rs page is pretty sparse https://docs.rs/parquet/8.0.0/parquet/
And there are no doc examples for using the new async reader api defined in #111
What changes are included in this PR?
Are there any user-facing changes?
Docs