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

Closed
Tracked by #12740
alamb opened this issue Oct 11, 2024 · 3 comments · Fixed by #12886
Closed
Tracked by #12740

Migrate documentation for all regex functions from scalar_functions.md to code #12868

alamb opened this issue Oct 11, 2024 · 3 comments · Fixed by #12886
Assignees
Labels
good first issue Good for newcomers

Comments

@alamb
Copy link
Contributor

alamb commented Oct 11, 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 the above named functions from the static documentation to code and to remove them from the static file.

Here is the current static content:

Need Functions:
(see source)

Describe the solution you'd like

One (or more) PRs that

  1. port the documentation for the above named functions from the static docs to code
  2. Bonus points: add sql examples should be added for all functions
  3. Remove the documentation from the static docs
  4. Run ./dev/update_function_docs.sh to update the dynamic documentation

Here are some example PRs of doing this:

  1. Crypto Function Migration #12840 from @jonathanc-n
  2. Migrate documentation for all string functions from scalar_functions.md to code  #12775 from @Omega359
  3. Port / Add Documentation for VarianceSample and VariancePopulation #12742

Describe alternatives you've considered

No response

Additional context

No response

@alamb
Copy link
Contributor Author

alamb commented Oct 11, 2024

I think this is a good first issue as the pattern is clear and it would be a good way to learn how the process works

@jonathanc-n
Copy link
Contributor

take

@jonathanc-n
Copy link
Contributor

Going to take this to make this large documentation migration a little faster. This is really helping me feel more comfortable with the different functions that datafusion has to offer

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

Successfully merging a pull request may close this issue.

2 participants