The code examples in README.md were failing due to imports.
I also investigated using byexample to automatically run code extracts in README.md but this is a pain due to how it expects both input and output. So instead suggest we rely on semantic versioning to not break these simple examples.
Fully backwards compatible: yes
PR checklist
[x] The quality checks are all passing
[ ] The bug case / new feature is covered by tests
[ ] Any new features are well-documented (in docstrings or notebooks)
Related issue(s)/PRs:
Summary
The code examples in README.md were failing due to imports.
I also investigated using byexample to automatically run code extracts in README.md but this is a pain due to how it expects both input and output. So instead suggest we rely on semantic versioning to not break these simple examples.
Fully backwards compatible: yes
PR checklist