Skip to content

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

Closed
#14163
#13926
Closed
doc-gen: Migrate builtin scalar functions from code based documentation to attribute based#13671
#14163
#13926
Assignees
Chen-Yuan-Lai
Labels
documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

Description

@comphead
comphead
opened on 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

Activity

  1. comphead
    added
    documentationImprovements or additions to documentation
    enhancementNew feature or request
    good first issueGood for newcomers
    help wantedExtra attention is needed
    and removed
    help wantedExtra attention is needed
    on Dec 5, 2024
  2. 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[/+] on Dec 6, 2024

  3. Chen-Yuan-Lai commented on Dec 9, 2024

    @Chen-Yuan-Lai
    Chen-Yuan-Lai
    on Dec 9, 2024
    Contributor

    take

  4. github-actions
    assigned
    Chen-Yuan-Lai
    on Dec 9, 2024

  5. Chen-Yuan-Lai commented on Dec 27, 2024

    @Chen-Yuan-Lai
    Chen-Yuan-Lai
    on Dec 27, 2024
    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

  6. Omega359 commented on Dec 27, 2024

    @Omega359
    Omega359
    on Dec 27, 2024
    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.

  7. jonahgao
    closed this as completedin #13926on Dec 28, 2024

  8. alamb commented on Dec 28, 2024

    @alamb
    alamb
    on Dec 28, 2024
    Contributor

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

  9. comphead
    reopened this on Dec 28, 2024

  10. comphead commented on Dec 28, 2024

    @comphead
    comphead
    on Dec 28, 2024
    ContributorAuthor

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

  11. alamb
    closed this as completedin #13920on Dec 29, 2024
  12. goldmedal
    reopened this on Dec 29, 2024

  13. comphead commented on Jan 16, 2025

    @comphead
    comphead
    on Jan 16, 2025
    ContributorAuthor

    Okay, I think some still left

    • GreatestFunc
    • ArrowCastFunc
    • ArrowTypeOfFunc
    • CoalesceFunc
    • GetFieldFunc
    • LeastFunc
    • NamedStructFunc
    • NullIfFunc
    • NVLFunc
    • NVL2Func
    • StructFunc

  14. Chen-Yuan-Lai commented on Jan 17, 2025

    @Chen-Yuan-Lai
    Chen-Yuan-Lai
    on Jan 17, 2025
    Contributor

    @comphead I'll complete these ignored functions

  15. comphead
    closed this as completedin #14163on Jan 17, 2025

  16. alamb commented on Jan 17, 2025

    @alamb
    alamb
    on Jan 17, 2025
    Contributor

    Nice work everyone and thank you @Chen-Yuan-Lai especially 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions