Improve parquet MetadataFetch and AsyncFileReader docs
#6505
Conversation
This file contains hidden or 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
Oct 3, 2024
| /// Return a future that fetches the specified range of bytes asynchronously | ||
| /// | ||
| /// Note the returned type is a boxed future, often created by | ||
| /// [FutureExt::boxed]. See the trait documentation for an example |
There was a problem hiding this comment.
If you are not familiar with rust futures BoxFuture is somewhat exotic. I will also make a PR upstream in futures to try and improve the docs there
There was a problem hiding this comment.
rust-lang/futures-rs#2887 -- we'll see what the maintainers say
This was referenced Oct 3, 2024
mbrobbel
reviewed
Oct 3, 2024
alamb
changed the title
MetadataFetch and AsyncFileReader docs
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
progval
reviewed
Oct 4, 2024
Co-authored-by: Val Lorentz <progval+github@progval.net>
Co-authored-by: Val Lorentz <progval+github@progval.net>
|
Thank you everyone for your suggestions and support. |
# for free
to join this conversation on GitHub.
Already have an account?
# 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?
Part of #6504
Rationale for this change
While working on the example for using parquet metadata in a local cache (#6081) some of these traits and how to implement them were not clear to me
What changes are included in this PR?
Add additional documentation and explanations
Are there any user-facing changes?
Better documentation and examples. No functional changes