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

Improved unparser documentation #11395

Merged
merged 2 commits into from
Jul 12, 2024
Merged

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jul 10, 2024

Draft as it builds on #11186

Which issue does this PR close?

Follow on to #11186

Rationale for this change

While reviewing #11186 from @MohamedAbdeen21 I found some areas that the docs could be improved

What changes are included in this PR?

Add module level / function level / struct level docstrings and examples

Are these changes tested?

By CI doc tests

Are there any user-facing changes?

better docs

@alamb alamb added the documentation Improvements or additions to documentation label Jul 10, 2024
@github-actions github-actions bot added sql SQL Planner logical-expr Logical plan and expressions and removed documentation Improvements or additions to documentation labels Jul 10, 2024
@alamb alamb force-pushed the alamb/unparser_docs branch from c60e132 to eba6e60 Compare July 11, 2024 16:20
@alamb alamb marked this pull request as ready for review July 11, 2024 16:21
@alamb
Copy link
Contributor Author

alamb commented Jul 11, 2024

FYI @devinjdangelo and @backkem

@alamb alamb added the documentation Improvements or additions to documentation label Jul 11, 2024
@github-actions github-actions bot removed documentation Improvements or additions to documentation logical-expr Logical plan and expressions labels Jul 12, 2024
Copy link
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.

lgtm thanks @alamb pretty useful thing this unparser

@comphead comphead merged commit a2a6458 into apache:main Jul 12, 2024
23 checks passed
@alamb
Copy link
Contributor Author

alamb commented Jul 12, 2024

lgtm thanks @alamb pretty useful thing this unparser

Yes, kudos belong to @backkem and @devinjdangelo for bringing the idea into DataFusion at first (from datafusion-federation) and to many contributors along the way that filled out the feature

findepi pushed a commit to findepi/datafusion that referenced this pull request Jul 16, 2024
xinlifoobar pushed a commit to xinlifoobar/datafusion that referenced this pull request Jul 17, 2024
xinlifoobar pushed a commit to xinlifoobar/datafusion that referenced this pull request Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sql SQL Planner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants