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

Make generate_function_docs.sh error if there is a function without documentation #12872

Closed
Tracked by #12740
alamb opened this issue Oct 11, 2024 · 1 comment · Fixed by #12938
Closed
Tracked by #12740

Make generate_function_docs.sh error if there is a function without documentation #12872

alamb opened this issue Oct 11, 2024 · 1 comment · Fixed by #12938
Assignees
Labels
enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented Oct 11, 2024

Is your feature request related to a problem or challenge?

Part of #12740

All functions in DataFusion should be documented on the documentation site https://datafusion.apache.org/user-guide/sql/index.html

Right now, we rely on manual code reviews to ensure this is the case, but we don't have any way to ensure all functions are documented (and indeed some are not)

Describe the solution you'd like

I would like CI to fail if a new function is added without documentation

Describe alternatives you've considered

I think we can modify the ./dev/update_function_docs.sh scrip / function to error when functions do not have documentation

Additional context

We do have to wait for all content to be ported to code before we can enable this check

@alamb
Copy link
Contributor Author

alamb commented Oct 15, 2024

Here is the PR to make it error: #12938

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant