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

Merged
merged 3 commits into from
Oct 1, 2024
Merged

Minor: improve ChunkedReader docs #6477

merged 3 commits into from
Oct 1, 2024

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
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).

alamb and others added 2 commits October 1, 2024 06:20
@alamb @tustvold
Update parquet/src/file/reader.rs
b9d4ded 
Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
@alamb
Get pedantic
56e90c3
@alamb
Copy link
Contributor Author

alamb commented Oct 1, 2024

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).

I added this note in 56e90c3 as well as consolidating the discussion about underlying mutations

etseidl
etseidl approved these changes Oct 1, 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.

Pedantically delicious 😋

@alamb alamb merged commit 551eaab into apache:master Oct 1, 2024
16 checks passed
@alamb
Copy link
Contributor Author

alamb commented Oct 1, 2024

Thanks everyone!

@alamb alamb deleted the alamb/chunk_reader_docs branch October 1, 2024 18:58
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