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 core functions from scalar_functions.md to code #12801

Closed
Omega359 opened this issue Oct 8, 2024 · 4 comments · Fixed by #12854
Closed

Migrate documentation for all core functions from scalar_functions.md to code #12801

Omega359 opened this issue Oct 8, 2024 · 4 comments · Fixed by #12854
Assignees
Labels
enhancement New feature or request

Comments

@Omega359
Copy link
Contributor

Omega359 commented Oct 8, 2024

Is your feature request related to a problem or challenge?

As part of #12740 this ticket is to migrate all the existing documentation for core functions from the scalar_functions.md file to code and to remove from the scalar_functions.md file. In addition sql examples should be added for all of the updated functions.

This includes:

  • arrow_cast
  • arrow_typeof
  • coalesce
  • named_struct
  • nullif
  • nvl
  • nvl2
  • struct
  • version

documentation should also be added for get_field which currently is not documented.

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Additional context

No response

@Omega359 Omega359 added the enhancement New feature or request label Oct 8, 2024
@Omega359
Copy link
Contributor Author

Omega359 commented Oct 8, 2024

take

@alamb
Copy link
Contributor

alamb commented Oct 8, 2024

@Omega359 do you think we/I should fix tickets for the other function catagories (to start parallelizing this work?)

@Omega359
Copy link
Contributor Author

Omega359 commented Oct 8, 2024

Sure! I was going by modules which do not line up perfectly with the sections in the docs but it shouldn't be that much of an issue. Otherwise I expect if I churn through them it'll be a week or two before I'm done.

@alamb
Copy link
Contributor

alamb commented Oct 9, 2024

Sure! I was going by modules which do not line up perfectly with the sections in the docs but it shouldn't be that much of an issue. Otherwise I expect if I churn through them it'll be a week or two before I'm done.

I filed #12828 and #12827 to start things off. We'll see how that goes and then I can file some more

Omega359 added a commit to Omega359/arrow-datafusion that referenced this issue Oct 10, 2024
alamb added a commit that referenced this issue Oct 11, 2024
… to code (#12854)

* Migrate documentation for all core functions from scalar_functions.md to code #12801

* Fixed formatting issue, regenerated documentation

* Update docs/source/user-guide/sql/scalar_functions.md

Co-authored-by: Andrew Lamb <[email protected]>

---------

Co-authored-by: Andrew Lamb <[email protected]>
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
2 participants