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 all documentation for all map functions from scalar_functions.md to code #13021

Closed
Omega359 opened this issue Oct 20, 2024 · 1 comment · Fixed by #13047
Closed

Migrate all documentation for all map functions from scalar_functions.md to code #13021

Omega359 opened this issue Oct 20, 2024 · 1 comment · Fixed by #13047
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Omega359
Copy link
Contributor

Is your feature request related to a problem or challenge?

https://datafusion.apache.org/user-guide/sql/scalar_functions.html#map-functions

  • map
  • make_map
  • map_extract
  • map_keys
  • map_values

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.

Note that make_map is special and is not a UDF and likely should be handled on a special page. see #12948 (comment)

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)

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

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

take

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

Successfully merging a pull request may close this issue.

3 participants