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: add examples for using displayable to show ExecutionPlans #13636

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Dec 4, 2024

Which issue does this PR close?

Part of #7013

Rationale for this change

While working on something internally, I found it would be quite helpful to have an examplefor displayable

displayable is mentioned on
https://docs.rs/datafusion/latest/datafusion/physical_plan/trait.ExecutionPlan.html

ExecutionPlan can be displayed in a simplified form using the return value from displayable in addition to the (normally quite verbose) Debug output.

But there is no example

What changes are included in this PR?

Add doc examples for this function

Are these changes tested?

Yes, by CI

Are there any user-facing changes?

@alamb alamb added the documentation Improvements or additions to documentation label Dec 4, 2024
@github-actions github-actions bot added physical-expr Physical Expressions and removed documentation Improvements or additions to documentation labels Dec 4, 2024
Copy link
Member

@jonahgao jonahgao left a comment

Choose a reason for hiding this comment

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

LGTM👍

@comphead comphead merged commit 589bfd4 into apache:main Dec 5, 2024
25 checks passed
@comphead
Copy link
Contributor

comphead commented Dec 5, 2024

Thanks @alamb and @jonahgao

@alamb alamb deleted the alamb/displayable_examples branch December 5, 2024 14:23
zhuliquan pushed a commit to zhuliquan/datafusion that referenced this pull request Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
physical-expr Physical Expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants