-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
CI_check_correctness_notebooks #49935
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
CI_check_correctness_notebooks #49935
Conversation
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.
Could you also add a step to .github/workflows/code-checks.yml
to run this check in the CI?
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!
ci/code_checks.sh
Outdated
@@ -12,9 +12,10 @@ | |||
# $ ./ci/code_checks.sh doctests # run doctests | |||
# $ ./ci/code_checks.sh docstrings # validate docstring errors | |||
# $ ./ci/code_checks.sh single-docs # check single-page docs build warning-free | |||
# $ ./ci/code_checks.sh notebooks # check correctness of documentation of notebooks |
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.
rather than 'correctness', which isn't really well-defined (😄 ), how about "check execution of documentation notebooks"?
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.
rather than 'correctness', which isn't really well-defined (😄 ), how about "check execution of documentation notebooks"?
Sure. Changed to the better wording in the second commit. Thank you, @MarcoGorelli
Thanks @mroeschke , added this in the second commit. |
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.
should be good, thanks @natmokval !
Awesome, thanks @natmokval |
This PR is related to the PR #49874.
Creating new PR, that checks correctness notebooks, as was discussed with @MarcoGorelli .
CI didn't fail when documentation notebook executed with an error. I added new notebooks section in
ci/code_checks.sh
to check if the notebook execution passes.