chore: Format examples in doc strings - spark, sql, sqllogictest, sibstrait #18443
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
sql
Weijun-H
reviewed
Nov 2, 2025
datafusion/sql/src/unparser/plan.rs
Outdated
| /// .unwrap() | ||
| /// .build() | ||
| /// .unwrap(); | ||
| /// let sql = plan_to_sql(&plan).unwrap(); // convert to AST |
Member
There was a problem hiding this comment.
It would be better to move // convert to AST to a new line.
Contributor
Author
There was a problem hiding this comment.
Hi @Weijun-H ,
thanks for the feedback! I've moved the // convert to AST comment to a new line.
PTAL when you get a chance. Thanks!
Jefffrey
reviewed
Nov 4, 2025
datafusion/sql/src/unparser/expr.rs
Outdated
Comment on lines
72
to
75
| /// let expr = col("a").gt(lit(4)); // form an expression `a > 4` | ||
| /// let sql = expr_to_sql(&expr).unwrap(); // convert to ast::Expr | ||
| /// // use the Display impl to convert to SQL text | ||
| /// // use the Display impl to convert to SQL text | ||
| /// assert_eq!(sql.to_string(), "(a > 4)") |
Contributor
There was a problem hiding this comment.
This looks funky; might need to move that display comment to be at the end of the assert_eq line or otherwise move all comments to their own line (before their related line of code)
Comment on lines
72
to
77
| /// let spans = get_spans( | ||
| /// "SELECT /*whole+left*/speed/*left*/ + /*right*/10/*right+whole*/ FROM cars", | ||
| /// ); | ||
| /// // whole is ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| /// // left is ^^^^^ | ||
| /// // right is ^^ |
Contributor
There was a problem hiding this comment.
I think the comments below need to be adjusted as they were referring to the original format
alamb
approved these changes
Nov 7, 2025
Contributor
There was a problem hiding this comment.
I took the liberty of fixing the issues identified by @Jefffrey and merging up from main
Thank you @CuteChuanChuan and @Weijun-H
Jefffrey
approved these changes
Nov 7, 2025
Contributor
Author
|
@alamb Thanks! ❤️ |
Contributor
Thank you for working on this project! |
hsiang-c
pushed a commit
to hsiang-c/datafusion
that referenced
this pull request
Nov 9, 2025
…strait (apache#18443) ## Which issue does this PR close? Part of apache#16915 ## Rationale for this change Format code examples in documentation comments to improve readability and maintain consistent code style across the codebase. This is part of a multi-PR effort to format all doc comment examples and eventually enable CI checks to enforce this formatting. ## What changes are included in this PR? Run `cargo fmt -p <crate> -- --config format_code_in_doc_comments=true` for the following datasource-related crates: - `datafusion-spark` - `datafusion-sql` - `datafusion-sqllogictest` - `datafusion-substrait` - `datafusion-cli` - `datafusion-examples` ## Are these changes tested? No testing needed - this is purely a formatting change with no functional modifications. ## Are there any user-facing changes? No - this only affects documentation formatting. --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
codetyri0n
pushed a commit
to codetyri0n/datafusion
that referenced
this pull request
Nov 11, 2025
…strait (apache#18443) ## Which issue does this PR close? Part of apache#16915 ## Rationale for this change Format code examples in documentation comments to improve readability and maintain consistent code style across the codebase. This is part of a multi-PR effort to format all doc comment examples and eventually enable CI checks to enforce this formatting. ## What changes are included in this PR? Run `cargo fmt -p <crate> -- --config format_code_in_doc_comments=true` for the following datasource-related crates: - `datafusion-spark` - `datafusion-sql` - `datafusion-sqllogictest` - `datafusion-substrait` - `datafusion-cli` - `datafusion-examples` ## Are these changes tested? No testing needed - this is purely a formatting change with no functional modifications. ## Are there any user-facing changes? No - this only affects documentation formatting. --------- Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Part of #16915
Rationale for this change
Format code examples in documentation comments to improve readability and maintain consistent code style across the codebase. This is part of a multi-PR effort to format all doc comment examples and eventually enable CI checks to enforce this formatting.
What changes are included in this PR?
Run
cargo fmt -p <crate> -- --config format_code_in_doc_comments=truefor the following datasource-related crates:datafusion-sparkdatafusion-sqldatafusion-sqllogictestdatafusion-substraitdatafusion-clidatafusion-examplesAre these changes tested?
No testing needed - this is purely a formatting change with no functional modifications.
Are there any user-facing changes?
No - this only affects documentation formatting.