alamb opened a new pull request, #12938: URL: https://github.com/apache/datafusion/pull/12938
Draft until we have completely migrated all function documentation ## Which issue does this PR close? Closes https://github.com/apache/datafusion/pull/12871 ## Rationale for this change The idea here is to ensure that all functions are documented, and ensure this is the case via a CI test. ## What changes are included in this PR? Changes: make the ./dev/update_function_docs.sh script error if there are undocumented functions Here is an example failure: ``` (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 Compiling datafusion v42.0.0 (/Users/andrewlamb/Software/datafusion/datafusion/core) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.77s Running `target/debug/print_functions_docs aggregate` INFO: The following functions do not have documentation: - regr_count - regr_avgx - regr_syy - regr_intercept - regr_slope - regr_sxy - regr_r2 - regr_sxx - regr_avgy Error: NotImplemented("Some functions do not have documentation. Please implement `documentation` for: {\"regr_count\", \"regr_avgx\", \"regr_syy\", \"regr_intercept\", \"regr_slope\", \"regr_sxy\", \"regr_r2\", \"regr_sxx\", \"regr_avgy\"}") (venv) andrewlamb@Andrews-MacBook-Pro-2:~/Software/datafusion$ ``` ## Are these changes tested? Yes, I tested it manually and here is an example of it failing ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
