Skip to content

Improve deprecation message for MemoryExec #14322

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 28, 2025
Merged

Improve deprecation message for MemoryExec #14322

merged 2 commits into from
Jan 28, 2025

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Jan 27, 2025

Which issue does this PR close?

Rationale for this change

@shehabgamin notes on #14008 (comment):

DataFusion
ValuesExec is now deprecated. The deprecation message is a bit confusing though. It currently states: "Use MemoryExec::try_new_as_values instead", but I think should say: "Use MemoryExec::try_new_as_values or MemoryExec::try_new_from_batches instead". Or, just simply: "Use MemoryExec instead".

What changes are included in this PR?

Improve documentation about deprecation and the suitable alternatives

Are these changes tested?

By CI

Are there any user-facing changes?

Only documentation, no functional change

@github-actions github-actions bot added the physical-expr Changes to the physical-expr crates label Jan 27, 2025
This was referenced Jan 27, 2025
Closed
Merged
shehabgamin
shehabgamin approved these changes Jan 27, 2025
View reviewed changes
Copy link
Contributor

@shehabgamin shehabgamin left a comment

Choose a reason for hiding this comment

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

Much better!

xudong963
xudong963 approved these changes Jan 28, 2025
View reviewed changes
Copy link
Member

@xudong963 xudong963 left a comment

Choose a reason for hiding this comment

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

clear

@xudong963 xudong963 merged commit 8d542ec into apache:main Jan 28, 2025
25 checks passed
@alamb alamb deleted the alamb/better_deprecatation_docs branch January 29, 2025 21:55
@alamb
Copy link
Contributor Author

alamb commented Jan 29, 2025

Thanks @xudong963 and @shehabgamin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xudong963 xudong963 xudong963 approved these changes

+1 more reviewer

@shehabgamin shehabgamin shehabgamin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

physical-expr Changes to the physical-expr crates

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alamb @shehabgamin @xudong963