Skip to content

Example device creation process and write tests docs#1484

Merged
oliwenmandiamond merged 24 commits intomainfrom
example_device_creation_process
Sep 3, 2025
Merged

Example device creation process and write tests docs#1484
oliwenmandiamond merged 24 commits intomainfrom
example_device_creation_process

Conversation

@oliwenmandiamond
Copy link
Contributor

@oliwenmandiamond oliwenmandiamond commented Aug 27, 2025

Fixes #634

Instructions to reviewer on how to test:

  1. Check tests pass
  2. Check added documentation makes sense and relevant.

Checks for reviewer

  • Would the PR title make sense to a scientist on a set of release notes
  • If a new device has been added does it follow the standards
  • If changing the API for a pre-existing device, ensure that any beamlines using this device have updated their Bluesky plans accordingly
  • Have the connection tests for the relevant beamline(s) been run via dodal connect ${BEAMLINE}

@codecov
Copy link

codecov bot commented Aug 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.75%. Comparing base (f3b53e9) to head (7595aed).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1484   +/-   ##
=======================================
  Coverage   98.75%   98.75%           
=======================================
  Files         235      235           
  Lines        8645     8645           
=======================================
  Hits         8537     8537           
  Misses        108      108           

☔ View full report in Codecov by Sentry.
📢 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.

@oliwenmandiamond oliwenmandiamond self-assigned this Aug 28, 2025
@oliwenmandiamond oliwenmandiamond marked this pull request as ready for review August 28, 2025 12:15
@oliwenmandiamond oliwenmandiamond requested a review from a team as a code owner August 28, 2025 12:15
@oliwenmandiamond
Copy link
Contributor Author

I have updated the docs on how to test your enums match epics and what you need to know when writing tests on devices in dodal. I am not sure my example is the best, so if you're able to suggest a better example for me to use that would be great! Thanks

Copy link
Collaborator

@noemifrisina noemifrisina left a comment

Choose a reason for hiding this comment

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

Just a couple of comments, it's good overall, just a bit clunky in a couple of places.
Example is nice, I don't think we need anything else to give a good idea what to do.

@oliwenmandiamond oliwenmandiamond changed the base branch from main to 1382-improve-documentation-on-device-apis-and-testing August 28, 2025 14:47
Base automatically changed from 1382-improve-documentation-on-device-apis-and-testing to main August 29, 2025 10:55
@oliwenmandiamond oliwenmandiamond merged commit 0929c10 into main Sep 3, 2025
10 checks passed
@oliwenmandiamond oliwenmandiamond deleted the example_device_creation_process branch September 3, 2025 09:15
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.

Add an example to showcase device creation process

5 participants