Skip to content

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

Merged
merged 2 commits into from
Nov 28, 2022

Conversation

natmokval
Copy link
Contributor

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.

Copy link
Member

@mroeschke mroeschke left a 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?

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Nice!

@@ -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
Copy link
Member

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"?

Copy link
Contributor Author

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

@MarcoGorelli MarcoGorelli added this to the 2.0 milestone Nov 28, 2022
@MarcoGorelli MarcoGorelli added the CI Continuous Integration label Nov 28, 2022
@natmokval
Copy link
Contributor Author

Could you also add a step to .github/workflows/code-checks.yml to run this check in the CI?

Thanks @mroeschke , added this in the second commit.

Copy link
Member

@MarcoGorelli MarcoGorelli left a 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 !

@mroeschke mroeschke merged commit 3c4b9b9 into pandas-dev:main Nov 28, 2022
@mroeschke
Copy link
Member

Awesome, thanks @natmokval

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants