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 of using TreeNode with Expr #10686

Merged
merged 1 commit 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 Expr 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 the logical-expr Logical plan and expressions label May 27, 2024
@alamb alamb added the documentation Improvements or additions to documentation label May 27, 2024
@alamb alamb marked this pull request as ready for review May 27, 2024 11:11
Copy link
Contributor Author

@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.

Here is what this looks like rendered:

Screenshot 2024-05-27 at 6 43 13 AM Screenshot 2024-05-27 at 6 43 16 AM

@alamb alamb changed the title Minor: Add examples of using TreeNode with Expr Minor: Add examples of using TreeNode with Expr May 27, 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.

Looks good to me 👍

@alamb
Copy link
Contributor Author

alamb commented May 29, 2024

Thanks for the review @jonahgao 🙏

@alamb alamb merged commit 59e2c7e into apache:main May 29, 2024
24 checks passed
findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
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 logical-expr Logical plan and expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants