Skip to content

docs: updating arrays_zip output field naming#22133

Open
timsaucer wants to merge 4 commits into
apache:mainfrom
timsaucer:doc/arrays_zip_update
Open

docs: updating arrays_zip output field naming#22133
timsaucer wants to merge 4 commits into
apache:mainfrom
timsaucer:doc/arrays_zip_update

Conversation

@timsaucer
Copy link
Copy Markdown
Member

@timsaucer timsaucer commented May 12, 2026

Which issue does this PR close?

No issue opened, but discovered regression in unit tests in datafusion-python during upgrading to main

Rationale for this change

Documentation only to let users know that they will need to update their field naming expectations. The change happened in #20886

What changes are included in this PR?

Upgrade guide document.

Are these changes tested?

N/A

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 12, 2026
@timsaucer
Copy link
Copy Markdown
Member Author

FYI @hsiang-c as the author of the upstream PR this caused a unit test regression in datafusion-python so I think we should have this note in the upgrade guide.

timsaucer added a commit to timsaucer/datafusion-python that referenced this pull request May 12, 2026
Comment thread docs/source/library-user-guide/upgrading/54.0.0.md Outdated
Copy link
Copy Markdown
Contributor

@hsiang-c hsiang-c left a comment

Choose a reason for hiding this comment

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

Thanks for catching it @timsaucer

Left one comment on the reference.

Co-authored-by: hsiang-c <137842490+hsiang-c@users.noreply.github.com>
@timsaucer
Copy link
Copy Markdown
Member Author

Thanks for catching it @timsaucer

Left one comment on the reference.

Excellent. Thank you for the correction!

@timsaucer timsaucer requested a review from comphead May 12, 2026 20:07
@hsiang-c
Copy link
Copy Markdown
Contributor

(nit) An update to the PR description if possible, not a must.

Copy link
Copy Markdown
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

Let me check this real quick

Comment thread docs/source/library-user-guide/upgrading/54.0.0.md Outdated

- Queries or downstream code that references the output struct fields by name
(e.g. `arrays_zip(a, b)['c0']`). Update field accessors to `'1'`, `'2'`,
etc.
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.

Suggested change
etc.
etc. Example `arrays_zip(a, b)[0]`

Co-authored-by: Oleks V <comphead@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

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

Thanks @timsaucer and @hsiang-c for catching this

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants