Skip to content

docs: Add simple devices and plans for use in tutorials - #1577

Open
abbiemery wants to merge 6 commits into
mainfrom
toy-devices
Open

docs: Add simple devices and plans for use in tutorials#1577
abbiemery wants to merge 6 commits into
mainfrom
toy-devices

Conversation

@abbiemery

Copy link
Copy Markdown
Contributor

With the removal of dodal as a dependency, we need to provide some simple devices and plans in order to follow through the tutorials. These are getting cleaned up in #1564.

@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.93%. Comparing base (b767635) to head (c86ab86).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1577   +/-   ##
=======================================
  Coverage   95.93%   95.93%           
=======================================
  Files          44       44           
  Lines        3300     3300           
=======================================
  Hits         3166     3166           
  Misses        134      134           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread src/blueapi/tutorial/plans.py Outdated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Is there a better place for this to live?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

utils would make the most sense if there's a way of getting it working without import order issues

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

utils but not include it in the __all__ ?

@abbiemery

abbiemery commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

After a lot of rabbit holes, I went back to using optional dependencies for the demo. I don't think the config should live in that module though, I will put it just in the docs.

@abbiemery
abbiemery requested a review from tpoliaw July 29, 2026 10:59
@abbiemery

Copy link
Copy Markdown
Contributor Author

If you can think of an actually useful test for the devices, let me know

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.

2 participants