Skip to content

Conversation

@CuteChuanChuan
Copy link
Contributor

@CuteChuanChuan CuteChuanChuan commented Oct 28, 2025

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=true for the following datasource-related crates:

  • datafusion-expr
  • datafusion-expr-common

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.

Copy link
Contributor

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

Thank you @CuteChuanChuan -- it is great to see the code train start

@alamb alamb added this pull request to the merge queue Oct 29, 2025
Merged via the queue into apache:main with commit 4e0596d Oct 29, 2025
32 of 33 checks passed
@CuteChuanChuan CuteChuanChuan deleted the raymond/16915-format-expr branch October 29, 2025 23:37
tobixdev pushed a commit to tobixdev/datafusion that referenced this pull request Nov 2, 2025
## 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-expr`
  - `datafusion-expr-common`

## 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants