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

Minor: improve scalar functions document #9029

Merged
merged 4 commits into from
Jan 30, 2024
Merged

Conversation

Weijun-H
Copy link
Member

Which issue does this PR close?

Closes #.

Rationale for this change

When I went through https://arrow.apache.org/datafusion/user-guide/sql/scalar_functions.html, I noticed that some function descriptions were complete while others were lacking aliases.

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added the logical-expr Logical plan and expressions label Jan 28, 2024
Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

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

Nice 👍


- **array**: Array expression.
Can be a constant, column, or function, and any combination of array operators.
- **begin**: Index of the first element.
Copy link
Contributor

Choose a reason for hiding this comment

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

Indicate that its 0/1 indexed?

Comment on lines 2698 to 2708
### `list_has`

_Alias of [array_has](#array_has)._

### `list_has_all`

_Alias of [array_has_a;;](#array_has_all)._

### `list_has_any`

_Alias of [array_has_any](#array_has_any)._
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry, what do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

As in add to that list there:

 - [list_has](#list_has)
 - [list_has_all](#list_has_all)
 - [list_has_any](#list_has_any) 

So the aliases appear in that list and are linked to

Copy link
Contributor

@comphead comphead 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 @Weijun-H !

@comphead comphead merged commit 3eb7080 into apache:main Jan 30, 2024
23 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.

3 participants