Refine ParquetRecordBatchReaderBuilder docs #5774
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
alamb
commented
May 16, 2024
| /// * For an asynchronous API - [`ParquetRecordBatchStreamBuilder`] | ||
| /// Most users should use one of the following specializations: | ||
| /// | ||
| /// * synchronous API: [`ParquetRecordBatchReaderBuilder::try_new`] |
There was a problem hiding this comment.
the examples / APIs are on try_new so I think that is the place to direct people rather than to ParquetRecordBatchReaderBuilder and then they have to find try_new
There was a problem hiding this comment.
I pushed a new example for ParquetRecordBatchStreamBuilder::new and changed the link
tustvold
reviewed
May 20, 2024
|
Thank you @tustvold |
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?
N/A
Rationale for this change
As part of working on another project, there were a few places where I thought the documentation could be improved (would have made it easier for me)
What changes are included in this PR?
Refine the docs in places that would have helped me
Are there any user-facing changes?
hopefully better docs