Skip to content

docs: Revise Parquet metadata module documentation - #10796

Merged
alamb merged 1 commit into
apache:mainfrom
etseidl:metadata_docs
Aug 25, 2026
Merged

docs: Revise Parquet metadata module documentation#10796
alamb merged 1 commit into
apache:mainfrom
etseidl:metadata_docs

Conversation

@etseidl

@etseidl etseidl commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

N/A

Rationale for this change

The form of the Parquet metadata has changed a great deal since the module documentation was written. It's time for a small refresh.

What changes are included in this PR?

Mention the new PageIndex structure and remove the ascii art diagram (sorry @alamb) that is now out of date. Since we no longer have two parallel sets of metadata objects, the section on the interplay between representation is no longer needed.

Are these changes tested?

N/A

Are there any user-facing changes?

No, just documentation

@github-actions github-actions Bot added the parquet Changes to the parquet crate label Aug 21, 2026

@alamb alamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While I do hate to lose the ascii art, the fact that we no longer need three sets of structs I think more than makes up for it.

Thank you @etseidl and @Rich-T-kid

@alamb alamb added the documentation Improvements or additions to documentation label Aug 25, 2026

@alamb alamb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While I do hate to lose the ascii art, the fact that we no longer need three sets of structs I think more than makes up for it.

Thank you @etseidl and @Rich-T-kid

@alamb
alamb merged commit 900ec3e into apache:main Aug 25, 2026
18 checks passed
@etseidl
etseidl deleted the metadata_docs branch August 25, 2026 19:52
Rich-T-kid pushed a commit to Rich-T-kid/arrow-rs that referenced this pull request Aug 28, 2026
# Which issue does this PR close?

N/A

# Rationale for this change

The form of the Parquet metadata has changed a great deal since the
module documentation was written. It's time for a small refresh.

# What changes are included in this PR?

Mention the new `PageIndex` structure and remove the ascii art diagram
(sorry @alamb) that is now out of date. Since we no longer have two
parallel sets of metadata objects, the section on the interplay between
representation is no longer needed.

# Are these changes tested?
N/A

# Are there any user-facing changes?
No, just documentation
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