Skip to content

Improve documentation for Signature, Volatility, and TypeSignature - #17264

Merged
alamb merged 8 commits into
apache:mainfrom
alamb:alamb/doc_signatures
Aug 22, 2025
Merged

Improve documentation for Signature, Volatility, and TypeSignature#17264
alamb merged 8 commits into
apache:mainfrom
alamb:alamb/doc_signatures

Conversation

@alamb

@alambalamb commented Aug 20, 2025

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

While reviewing #17195 from @mbutrovich and other recent PRs related to type signatures, I believe the current behavior and implications of TypeSignatures is not clear; I think it is especially confusing to understand what "supported" means

Thus I would like to improve the docs to help

What changes are included in this PR?

Improve the documentation for type signatures in general to explain what they mean and the implications better.

Are these changes tested?

By CI

Are there any user-facing changes?

Some better docs and examples

@alambalamb added the documentation Improvements or additions to documentation label Aug 20, 2025
@github-actionsgithub-actionsBot added logical-expr Logical plan and expressions and removed documentation Improvements or additions to documentation labels Aug 20, 2025
@mbutrovich
mbutrovich self-requested a review August 20, 2025 17:24
Jefffrey
Jefffrey reviewed Aug 21, 2025
View reviewed changes
Comment threaddatafusion/expr-common/src/signature.rs Outdated
Comment threaddatafusion/expr-common/src/signature.rs
Comment threaddatafusion/expr-common/src/signature.rs Outdated
Comment threaddatafusion/expr/src/udf.rs
Comment threaddatafusion/expr/src/udf.rs Outdated
2010YOUY01
2010YOUY01 reviewed Aug 21, 2025
View reviewed changes
Comment threaddatafusion/expr-common/src/signature.rs Outdated
Comment threaddatafusion/expr-common/src/signature.rs Outdated
@alambalamb added the documentation Improvements or additions to documentation label Aug 21, 2025
Jefffrey
Jefffrey approved these changes Aug 22, 2025
View reviewed changes

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

LGTM 👍

@alamb
alamb merged commit 9e062df into apache:mainAug 22, 2025
27 checks passed
@alamb

alamb commented Aug 22, 2025•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Thank you @Jefffrey and @2010YOUY01

@alamb
alamb deleted the alamb/doc_signatures branch August 22, 2025 13:09
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@2010YOUY012010YOUY012010YOUY01 left review comments
@JefffreyJefffreyJefffrey approved these changes
@mbutrovichmbutrovichAwaiting requested review from mbutrovich

Assignees

No one assigned

Labels

documentationImprovements or additions to documentationlogical-exprLogical plan and expressions

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alamb@Jefffrey@2010YOUY01