Skip to content

test: reject hyphenated UDF argument names - #24751

Open
mattisonchao wants to merge 1 commit into
apache:mainfrom
mattisonchao:docs/validate-udf-argument-names
Open

test: reject hyphenated UDF argument names#24751
mattisonchao wants to merge 1 commit into
apache:mainfrom
mattisonchao:docs/validate-udf-argument-names

Conversation

@mattisonchao

@mattisonchao mattisonchao commented Aug 28, 2026

Copy link
Copy Markdown
Member

Which issue does this PR close?

Rationale for this change

UDF argument names are copied into generated function documentation. Hyphenated names make the documentation inconsistent with the underscore style used by SQL syntax, and the repository currently has no automated check preventing them from being reintroduced.

What changes are included in this PR?

Adds a function-documentation test that scans the scalar, higher-order, aggregate, and window UDF registries and reports any hyphenated argument name, directing contributors to use underscores. The existing SQL table-format test now shares the same registry traversal helper.

Are these changes tested?

Yes.

Are there any user-facing changes?

No. This validates repository-owned generated documentation metadata and does not change SQL behavior or public APIs.

@github-actions github-actions Bot added the core Core DataFusion crate label Aug 28, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.47%. Comparing base (c56a7ab) to head (4221f36).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #24751      +/-   ##
==========================================
- Coverage   81.47%   81.47%   -0.01%     
==========================================
  Files        1122     1122              
  Lines      404140   404140              
  Branches   404140   404140              
==========================================
- Hits       329284   329273      -11     
- Misses      55546    55553       +7     
- Partials    19310    19314       +4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Jefffrey Jefffrey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you show an example of this test failing, just to see what the output looks like

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants