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 remaining window functions to window_functions.md #12936

Closed
Tracked by #12740
alamb opened this issue Oct 15, 2024 · 6 comments
Closed
Tracked by #12740
Assignees
Labels
good first issue Good for newcomers

Comments

@alamb
Copy link
Contributor

alamb commented Oct 15, 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

@buraksenn
Copy link
Contributor

take

@buraksenn
Copy link
Contributor

I started working on this but I think this needs to be done after #8709 epic finishes since window functions are in progress of refactoring and they need to be refactored such that their documents are added in datafusion/functions-window/src instead of datafusion/expr/src/window_function.rs. I will track those changes and open a PR if it is okay

@alamb
Copy link
Contributor Author

alamb commented Oct 16, 2024

Thanks @buraksenn -- that sounds great. Thank you

@Omega359
Copy link
Contributor

Would it be possible to add documentation for lead/lag prior to waiting for all the remaining window functions to be migrated over?

@buraksenn
Copy link
Contributor

buraksenn commented Oct 24, 2024

@Omega359 added lead/lag window function docs in the PR above

@alamb
Copy link
Contributor Author

alamb commented Oct 24, 2024

I think this is now done (thank you @buraksenn and @Omega359 )

I am hoping that we can merge #12938 and then that will prevent any new functions from being added that don't have documentation (aka it will ensure that the ported window functions are documented)

@alamb alamb closed this as completed Oct 24, 2024
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

No branches or pull requests

3 participants