-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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 CI error if a function has no documentation #12938
Conversation
c8244ac
to
a8b4d38
Compare
@@ -48,12 +49,13 @@ fn main() { | |||
_ => { | |||
panic!("Unknown function type: {}", function_type) | |||
} | |||
}; | |||
}?; | |||
|
|||
println!("{docs}"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need this println?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. This is how the shell script that builds the .md files retrieves the text. see https://github.com/apache/datafusion/blob/main/dev/update_function_docs.sh for impl.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm thanks @alamb
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice addition!
Bam ! Thank you for the reviews @comphead @Omega359 and @timsaucer -- We are so close to getting the docs all migrated over |
Draft until we have completely migrated all function documentation. The CI will fail until all currently existing functions are documented
Which issue does this PR close?
Closes #12872
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:
Are these changes tested?
Yes, I tested it manually and here is an example of it failing
Are there any user-facing changes?