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.

Sign up for GitHub

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

Jump to bottom

Minor: improve ChunkedReader docs #6477

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Minor: improve ChunkedReader docs #6477

wants to merge 1 commit into from

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Sep 28, 2024

Which issue does this PR close?

Rationale for this change

While reviewing various PRs I found I had to remind myself several times what a ChunkReader was used for and how multiple instances of Read were connected and how any implicit "offset" was modeled

What changes are included in this PR?

Add some additional documentation!

Are there any user-facing changes?

@github-actions github-actions bot added the parquet Changes to the parquet crate label Sep 28, 2024
alamb
alamb commented Sep 28, 2024
View reviewed changes
parquet/src/file/reader.rs
@@ -45,23 +45,39 @@ pub trait Length {
fn len(&self) -> u64;
}

/// The ChunkReader trait generates readers of chunks of a source.
/// Generates [`Read`]ers to read chunks of a Parquet data source.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@etseidl and @tustvold I tried to update the documentation. Does this match your understanding of how ChunkReader is used?

etseidl
etseidl approved these changes Sep 29, 2024
View reviewed changes
Copy link
Contributor

@etseidl etseidl left a comment

Choose a reason for hiding this comment

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

I think this is a nice improvement. Thanks @alamb.

The pedant in me just wonders if the docs should mention that this trait provides random access (via get_bytes) as well as sequential (via get_read).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tustvold tustvold tustvold approved these changes

@etseidl etseidl etseidl approved these changes

Assignees
No one assigned
Labels
parquet Changes to the parquet crate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alamb @tustvold @etseidl