Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about type signatures, and export TIMEZONE_WILDCARD #7726

Merged
merged 3 commits into from
Oct 7, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 2, 2023

Which issue does this PR close?

Follow on to #7720

Rationale for this change

While reviewing #7720 from @mhilton
I realized that the type coercion / signatures were not as well documented as well as they could be (e.g. the fact that DataFuson would coerce arguments for example, was somewhat implied).

What changes are included in this PR?

  1. Improve the Signature and TypeSignature documentation
  2. Rename TIMEZONE_PLACEHOLDER to TIMEZONE_WILDCARD (added in fix: coerce text to timestamps with timezones #7720) to better represent what it means

Are these changes tested?

Yes, with a new doc example as well as existing tests

Are there any user-facing changes?

better docs and TIMEZONE_WILDCARD is better documented

@github-actions github-actions bot added the logical-expr Logical plan and expressions label Oct 2, 2023
@alamb alamb changed the title Add documentation and export TIMEZONE_WILDCARD Add documentation about type signatures, and export TIMEZONE_WILDCARD Oct 2, 2023
Copy link
Contributor

@2010YOUY01 2010YOUY01 left a comment

Choose a reason for hiding this comment

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

Nice doc, I also found Volatility confusing when first saw it

datafusion/expr/src/signature.rs Outdated Show resolved Hide resolved
datafusion/expr/src/signature.rs Show resolved Hide resolved
Copy link
Contributor

@mhilton mhilton left a comment

Choose a reason for hiding this comment

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

Thanks for those documentation changes, they make things a lot clearer.

Copy link
Member

@yjshen yjshen left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @alamb!

@alamb
Copy link
Contributor Author

alamb commented Oct 7, 2023

Thanks @yjshen !

@alamb alamb merged commit 0809f45 into apache:main Oct 7, 2023
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
logical-expr Logical plan and expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants