Skip to content

docs: Add section or page for special functions #13036

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

Closed
Omega359 opened this issue Oct 21, 2024 · 2 comments · Fixed by #13102
Closed

docs: Add section or page for special functions #13036

Omega359 opened this issue Oct 21, 2024 · 2 comments · Fixed by #13102
Assignees
Labels
enhancement New feature or request

Comments

@Omega359
Copy link
Contributor

Is your feature request related to a problem or challenge?

As mentioned in #12948 (comment) there are a few scalar functions that are not normal UDF's and cannot be documented in the standard manner as per #12740 Thus we need to find a way to add documentation for those functions to the user guide once the scalar function documentation is completely migrated over to the new code driven design.

Describe the solution you'd like

A few idea:

  • Hardcode a section into the generated scalar-functions.md for these functions
  • Add a new page to the documentation that outlines 'special' functions

Describe alternatives you've considered

No response

Additional context

No response

@jonathanc-n
Copy link
Contributor

take

@Omega359
Copy link
Contributor Author

Here is a list of the remaining 'special' functions as I see it. Unnest is really the only special function, the others are just existing functions with different syntax such as substring('Thomas' from 2 for 3) → hom.

  • unnest (array), unnest(struct)
  • extract - it's data_part, but with different syntax
  • position - it's strpos, but with different syntax
  • substring, it's substr, but with different syntax
  • trim, it's one of the trim functions, but with different syntax

I am unsure right now how to properly document the 'different syntax' types of functions. Perhaps these should be covered in a page that covers things like ilike, cube, trim, etc.

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