Skip to content

docs(variant): link VariantArray doc to official Parquet Variant extension type#9779

Merged
scovich merged 1 commit intoapache:mainfrom
mcharrel:mc/variant-array-doc-update
Apr 21, 2026
Merged

docs(variant): link VariantArray doc to official Parquet Variant extension type#9779
scovich merged 1 commit intoapache:mainfrom
mcharrel:mc/variant-array-doc-update

Conversation

@mcharrel
Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Closes none (doc-only follow-up to apache/arrow#46908, which was closed 2025-09-17 when the canonical extension type was published).

Rationale for this change

The VariantArray struct-level doc comment currently states:

At the time of this writing, Variant has been accepted as an official extension type but not been published to the official list of extension types on the Apache Arrow website.

That is no longer true: Parquet Variant is now documented as a canonical Arrow extension type under the Parquet Variant section of CanonicalExtensions. The rendered rustdoc for VariantArray is therefore stale.

What changes are included in this PR?

Update the # Documentation section of the VariantArray rustdoc to link directly to the #parquet-variant anchor of the canonical extensions page, and drop the reference to the now-closed tracking issue.

Are there any user-facing changes?

Documentation only — no API or behavior changes.

…Variant extension type

The Variant extension type has been published to the official list of
canonical Arrow extension types at the Parquet Variant section. Update
the VariantArray doc comment to link there instead of claiming it has
not yet been published and referencing the now-closed tracking issue
apache/arrow#46908.
@github-actions github-actions Bot added the parquet-variant parquet-variant* crates label Apr 21, 2026
Copy link
Copy Markdown
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thank you @mcharrel

fyi @scovich

@alamb alamb added the documentation Improvements or additions to documentation label Apr 21, 2026
Copy link
Copy Markdown
Contributor

@scovich scovich left a comment

Choose a reason for hiding this comment

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

LGTM!

@scovich scovich merged commit 922bdd5 into apache:main Apr 21, 2026
17 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-variant parquet-variant* crates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants