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

Update device factory docs #855

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

Conversation

DiamondJoseph
Copy link
Contributor

Updates docs on how to create a beamline for changes in ophyd-async and dodal.
After #405 goes in with the epics-containers mocks, we could have the docs built against those devices?

Instructions to reviewer on how to test:

  1. Read the changed docs to ensure they make sense
  2. Make the example beamline described in the docs
  3. Ensure that devices connect/skip/mock appropriately

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}

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.19%. Comparing base (ecc1a20) to head (7d1d0cb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #855   +/-   ##
=======================================
  Coverage   95.19%   95.19%           
=======================================
  Files         120      120           
  Lines        4976     4976           
=======================================
  Hits         4737     4737           
  Misses        239      239           

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

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.

1 participant