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

Minor: Clarify docs on EnabledStatistics #5812

Merged
merged 3 commits into from
May 29, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 28, 2024

Which issue does this PR close?

Rationale for this change

While working to add an example of pruning with these statistics in DataFusion apache/datafusion#10701 I ran across the term "chunk statistics"

I think from the context this means "column chunk" which would be good to clarify for the casual reader

What changes are included in this PR?

  1. Clarify docs

Are there any user-facing changes?

This is only a documentation change. There are no functional changes.

@alamb alamb marked this pull request as ready for review May 28, 2024 20:03
@github-actions github-actions bot added the parquet Changes to the parquet crate label May 28, 2024
/// Controls the level of statistics to be computed by the writer and stored in
/// the parquet file.
///
/// Enabling statistics makes the resulting Parquet file larger and requires
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it is useful to help people understand the implications of these settings as well so I tried to clarify the tradeoff here

@alamb alamb added the documentation Improvements or additions to documentation label May 28, 2024
parquet/src/file/properties.rs Outdated Show resolved Hide resolved
Co-authored-by: Raphael Taylor-Davies <[email protected]>
@tustvold tustvold merged commit 12f57af into apache:master May 29, 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.

2 participants