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.

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

Improve Parquet reader/writer properties docs #5863

Merged
merged 5 commits into from
Jun 12, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 10, 2024

Which issue does this PR close?

Related to #5770

Rationale for this change

I had to go poking around in the code to determine what the default values for the writer properties were. I think it would be helpful to have this information in the docs.

What changes are included in this PR?

This PR adds the default values to the docs for the writer properties.

Are there any user-facing changes?

@github-actions github-actions bot added the parquet Changes to the parquet crate label Jun 10, 2024
@alamb
Copy link
Contributor Author

alamb commented Jun 10, 2024

MSRV failure is due to #5864

Copy link
Contributor

@progval progval left a comment

Choose a reason for hiding this comment

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

Thanks, that's very helpful

parquet/src/file/properties.rs Outdated Show resolved Hide resolved
parquet/src/file/properties.rs Outdated Show resolved Hide resolved
@alamb alamb added the documentation Improvements or additions to documentation label Jun 11, 2024
@alamb
Copy link
Contributor Author

alamb commented Jun 11, 2024

Thank you @progval

parquet/src/file/properties.rs Outdated Show resolved Hide resolved
parquet/src/file/properties.rs Outdated Show resolved Hide resolved
Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
@tustvold tustvold merged commit 8bee08b into apache:master Jun 12, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants