Repository navigation
Migrate documentation for all math functions from scalar_functions.md to code #12867
Description
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/src/math
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.shto update the dynamic documentation
Here are some example PRs of doing this:
- Crypto Function Migration #12840 from @jonathanc-n
- Migrate documentation for all string functions from scalar_functions.md to code #12775 from @Omega359
- Port / Add Documentation for
VarianceSampleandVariancePopulation#12742
Describe alternatives you've considered
No response
Additional context
No response
Activity
alamb commentedon 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
juroberttyb commentedon Oct 12, 2024
take
juroberttyb commentedon Oct 13, 2024
Hi @alamb, thank you for providing this opportunity for new comers to learn more about the repo!
I have opened a PR, could you or someone help me review it when you have time?
alamb commentedon Oct 14, 2024
Thank you @juroberttyb -- I will review your PR shortly.
Sorry for the delay
juroberttyb commentedon Oct 15, 2024
No problem at all. Thank you for the help!