Skip to content

Fix syntax examples of some functions#23212

Open
Viicos wants to merge 3 commits into
apache:mainfrom
Viicos:vp/array_transform-docs
Open

Fix syntax examples of some functions#23212
Viicos wants to merge 3 commits into
apache:mainfrom
Viicos:vp/array_transform-docs

Conversation

@Viicos

@Viicos Viicos commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Almost all the datafusion functions uses a consistent format for the syntax_example which describes the expected signature of the function (that is, func_name(arg1, arg2 [, optional_arg]), apart from some functions with specific syntax, e.g. array_agg(expression [ORDER BY expression])).

I'm trying to programmatically parse this syntax and map it to the argument user_doc directive, but some of them weren't following the same pattern.

Also properly document the lambda parameter of array_transform.

@github-actions github-actions Bot added documentation Improvements or additions to documentation functions Changes to functions implementation labels Jun 26, 2026
@Viicos Viicos force-pushed the vp/array_transform-docs branch from 5a23e8c to ac32954 Compare June 26, 2026 20:45
@Viicos Viicos changed the title Fix syntax example of array_transform function Fix syntax examples of some functions Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation functions Changes to functions implementation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant