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.

Sign up for GitHub

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

Jump to bottom

doc-gen: Migrate builtin scalar functions from code based documentation to attribute based #13671

Open
comphead opened this issue Dec 5, 2024 · 5 comments · Fixed by #13926 · May be fixed by #13921 or #13878
Open

doc-gen: Migrate builtin scalar functions from code based documentation to attribute based #13671

comphead opened this issue Dec 5, 2024 · 5 comments · Fixed by #13926 · May be fixed by #13921 or #13878
Assignees
@Chen-Yuan-Lai
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@comphead
Copy link
Contributor

comphead commented Dec 5, 2024

Is your feature request related to a problem or challenge?

It is needed to migrate whenever it is possible builtin UDF documentation from code based to attribute based.

Function list can be found in SessionStateDefaults::default_scalar_functions()

Example can be found https://github.com/apache/datafusion/pull/13646/files#diff-1528bf73810e3fb12fd1d4e76a8b46acb650549ef37d3c131464e087f97ca515L25

The translation can be done manually or in semi automatic way, uncommenting a function in PR #13669 locally. This will generate local text files with attribute text which can be copy pasted to structs. However its still needed to remove code based documentation manually, add imports, etc

Please refer to PR #13646 which completed the migration for aggregation functions

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

Additional context

No response
@comphead comphead added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Dec 5, 2024
@alamb alamb changed the title doc-gen: Migrate builtin functions from code based documentation to attribute based doc-gen: Migrate builtin scalar functions from code based documentation to attribute based Dec 6, 2024
@Chen-Yuan-Lai
Copy link
Contributor

take

This was referenced Dec 22, 2024
Draft
Merged
Open
Merged
Open
Merged
Merged
Open
Open
Merged
Open
Merged
Open
Open
@Chen-Yuan-Lai
Copy link
Contributor

Hi @alamb @Omega359 @comphead I've split the changes into several smaller PRs based on function categories. Could you please review these PRs? Thx 🙏

BTW, I put Cargo.toml and Cargo.lock changes in #13928 , this PR may need to be merged first than other array functions PRs

@Omega359
Copy link
Contributor

Thanks for all your work on this! I'll do my best to start reviewing these PR's this weekend if no one beats me to it.

@alamb
Copy link
Contributor

alamb commented Dec 28, 2024

Thank you @Chen-Yuan-Lai and @Omega359 for driving this forward

@comphead comphead reopened this Dec 28, 2024
@comphead
Copy link
Contributor Author

Supposedly it was closed automatically, I think we can close it once all the PRs merged.

@goldmedal goldmedal reopened this Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Chen-Yuan-Lai Chen-Yuan-Lai

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
5 participants
@Omega359 @alamb @goldmedal @comphead @Chen-Yuan-Lai