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

add test to run python-code example in readme #38

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

leifdenby
Copy link
Member

@leifdenby leifdenby commented Nov 28, 2024

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

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the documentation to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging)

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

Add missing test that ensures that python-code example in README executes without error.
@leifdenby leifdenby added this to the v0.3.0 (proposed) milestone Nov 28, 2024
Copy link

@khintz khintz left a 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 ;)

tests/test_readme.py Outdated Show resolved Hide resolved
Copy link
Contributor

@joeloskarsson joeloskarsson left a 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

tests/test_readme.py Show resolved Hide resolved
tests/test_readme.py Show resolved Hide resolved
Copy link

@khintz khintz left a 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.

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

Successfully merging this pull request may close these issues.

3 participants