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

Print undocumented functions to console while generating docs #12874

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 11, 2024

Which issue does this PR close?

Part of #12740

First part of #12872

Rationale for this change

Eventually I would like to ensure that all functions have documentation. Now that we have the automated documentation builder in place, it is possible to see what is missing.

What changes are included in this PR?

As first step, update the print docs script to print out the list of functions that are not documented. As a follow on PR I will make this an error once we have all functions documented

Are these changes tested?

I tested them manually. Here is what it looks like:

INFO: The following functions do not have documentation:
  - regr_avgy
  - regr_sxx
  - regr_slope
  - regr_r2
  - regr_count
  - regr_avgx
  - regr_syy
  - regr_intercept
  - regr_sxy
...

Here is what it looked like before

(venv) andrewlamb@Andrews-MacBook-Pro-2:~/Software/datafusion$ ./dev/update_function_docs.sh
/Users/andrewlamb/Software/datafusion
Inserting header
Running CLI and inserting aggregate function docs table
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/print_functions_docs aggregate`
Running prettier
docs/source/user-guide/sql/aggregate_functions_new.md 58ms
'docs/source/user-guide/sql/aggregate_functions_new.md' successfully updated!
Inserting header
Running CLI and inserting scalar function docs table
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.09s
     Running `target/debug/print_functions_docs scalar`
Running prettier
docs/source/user-guide/sql/scalar_functions_new.md 93ms
'docs/source/user-guide/sql/scalar_functions_new.md' successfully updated!
Inserting header
Running CLI and inserting window function docs table
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.09s
     Running `target/debug/print_functions_docs window`
Running prettier
docs/source/user-guide/sql/window_functions_new.md 23ms
'docs/source/user-guide/sql/window_functions_new.md' successfully updated!

Are there any user-facing changes?

@alamb
Copy link
Contributor Author

alamb commented Oct 11, 2024

FYI @Omega359 and @jonathanc-n

@github-actions github-actions bot added the core Core DataFusion crate label Oct 11, 2024
Copy link
Contributor

@Omega359 Omega359 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks @alamb

@jonathanc-n
Copy link
Contributor

this LGTM thanks for the help @alamb

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm thanks @alamb

@alamb alamb merged commit 21cb357 into apache:main Oct 14, 2024
31 of 48 checks passed
@alamb alamb deleted the alamb/print_missing_docs branch October 14, 2024 11:41
@alamb
Copy link
Contributor Author

alamb commented Oct 14, 2024

Thank you everyone for the review

hailelagi pushed a commit to hailelagi/datafusion that referenced this pull request Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants