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

Migrate documentation for all array functions from scalar_functions.md to code #12927

Closed
Tracked by #12740
jonathanc-n opened this issue Oct 14, 2024 · 3 comments · Fixed by #12948
Closed
Tracked by #12740

Migrate documentation for all array functions from scalar_functions.md to code #12927

jonathanc-n opened this issue Oct 14, 2024 · 3 comments · Fixed by #12948
Assignees
Labels
enhancement New feature or request

Comments

@jonathanc-n
Copy link
Contributor

jonathanc-n commented Oct 14, 2024

Is your feature request related to a problem or challenge?

Is your feature request related to a problem or challenge?
As part of #12740 this ticket is to migrate all the existing documentation for the above named functions from the static documentation to code and to remove them from the static file.

Here is the current static content:

doc source: https://github.com/apache/datafusion/blob/main/docs/source/user-guide/sql/scalar_functions.md
rendered: https://datafusion.apache.org/user-guide/sql/scalar_functions.html
Code source: https://github.com/apache/datafusion/tree/main/datafusion/functions-nested
Need Functions:
(see source)

Additional context
No response

Describe the solution you'd like

One (or more) PRs that

port the documentation for the above named functions from the static docs to code
Bonus points: add sql examples should be added for all functions
Remove the documentation from the static docs
Run ./dev/update_function_docs.sh to update the dynamic documentation
Here are some example PRs of doing this:

#12840 from @jonathanc-n
Migrate documentation for all string functions from scalar_functions.md to code #12775 from @Omega359
#12742

Describe alternatives you've considered

No response

Additional context

No response

@jonathanc-n jonathanc-n added the enhancement New feature or request label Oct 14, 2024
@jonathanc-n
Copy link
Contributor Author

take

@jonathanc-n
Copy link
Contributor Author

@alamb This can be added to the #12740

@alamb
Copy link
Contributor

alamb commented Oct 15, 2024

@alamb This can be added to the #12740

Done -- thank you @jonathanc-n

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants