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.

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

Minor: Add examples of using TreeNode with LogicalPlan #10687

Merged
merged 3 commits into from
May 29, 2024
Merged

Minor: Add examples of using TreeNode with LogicalPlan #10687

merged 3 commits into from
May 29, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 27, 2024

Which issue does this PR close?

Part of #10121 and #7013

Rationale for this change

As @berkaysynnada says on @peter-toth 's amazing PR ' #10543

Our TreeNode API functionality has reached a very good level. You've done a great job. Perhaps we could add documentation with code snippets to exemplify the usage of methods and their purposes, to ease the experience for less experienced users.

What changes are included in this PR?

This PR adds examples to LogicalPlan and documentation to show how to use the TreeNode API

Are these changes tested?

Yes, new doc examples

Are there any user-facing changes?

@github-actions github-actions bot added logical-expr Logical plan and expressions core Core DataFusion crate labels May 27, 2024
@alamb alamb mentioned this pull request May 27, 2024
Merged
@alamb alamb marked this pull request as ready for review May 27, 2024 12:12
jonahgao
jonahgao approved these changes May 29, 2024
View reviewed changes
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.

Looks good to me!

@alamb alamb merged commit 2796e01 into apache:main May 29, 2024
23 checks passed
@alamb
Copy link
Contributor Author

alamb commented May 29, 2024

Thanks again for the review @jonahgao

@alamb alamb deleted the alamb/logical_plan_rewrite_docs branch May 29, 2024 12:00
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
@alamb @jonahgao @findepi
Minor: Add examples of using TreeNode with LogicalPlan (apache#10687)
dcf6b52 
* Improve LogicalPlan documentation

* Apply suggestions from code review

Co-authored-by: Jonah Gao <[email protected]>

---------

Co-authored-by: Jonah Gao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonahgao jonahgao jonahgao approved these changes

Assignees
No one assigned
Labels
core Core DataFusion crate logical-expr Logical plan and expressions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alamb @jonahgao