chore: Format examples in doc strings - functions #18353
Merged
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
|
I see the CI failed. Let me investigate the error and will fix it shortly. |
Weijun-H
approved these changes
Nov 2, 2025
|
Thank you @Weijun-H and @CuteChuanChuan |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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-functionsdatafusion-functions-aggregatedatafusion-functions-aggregate-commondatafusion-functions-nesteddatafusion-functions-tabledatafusion-functions-windowdatafusion-functions-window-commonAre 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.