-
Notifications
You must be signed in to change notification settings - Fork 9
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
add test to run python-code example in readme #38
base: main
Are you sure you want to change the base?
Conversation
Add missing test that ensures that python-code example in README executes without error.
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.
Good idea to test the code blocks in the readme.
But you have to be extremely convincing to make me approve without adding an entry to the changelog ;)
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.
Good idea to add this! lgtm
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.
This looks good. Except for the conflict which has to be fixed of course.
Add missing test that ensures that python-code example in README executes without error.
Describe your changes
Add a test which looks for python codeblocks in README and executes them. Having this test will ensure that python codeblock examples in README keep working as the codebase evolves.
No changes to dependencies.
Issue Link
In reviewing #32 I just realised that the example in the README hadn't been updated. I am adding this test to ensure that that should be caught be tests in future.
Type of change
Checklist before requesting a review
pull
with--rebase
option if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee