Skip to content

Conversation

@DominicOram
Copy link
Contributor

@DominicOram DominicOram commented Jan 20, 2026

Fixes #1831

Requires #1829 to be merged first

Note for old ophyd devices this seems to actually try and connect and fail. I think we leave as is given that we should be off ophyd soon

Instructions to reviewer on how to test:

  1. Run dodal describe i03
  2. Confirm information for every device is printed (where available)

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}

@DominicOram DominicOram requested a review from a team as a code owner January 20, 2026 15:40
@codecov
Copy link

codecov bot commented Jan 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.06%. Comparing base (405e437) to head (c42e2f8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1833   +/-   ##
=======================================
  Coverage   99.05%   99.06%           
=======================================
  Files         289      289           
  Lines       11030    11079   +49     
=======================================
+ Hits        10926    10975   +49     
  Misses        104      104           

☔ 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.

@DominicOram DominicOram marked this pull request as draft January 20, 2026 15:49
@DominicOram DominicOram marked this pull request as ready for review January 20, 2026 16:45
@DominicOram DominicOram requested a review from tpoliaw January 20, 2026 17:01
@oliwenmandiamond
Copy link
Contributor

oliwenmandiamond commented Jan 21, 2026

Would it be good to have a line break between each device doc? e.g something like

************************

or

----------------------------

Feel the output could get cluttered and hard to know where a device doc ends?
We could make it an optional flag e.g --line-break, -lb

dodal describe iXX -lb

Copy link
Contributor

@tpoliaw tpoliaw left a comment

Choose a reason for hiding this comment

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

There's room for improvement in the information the factories offer but this is a useful command as it is so worth merging and updating later if/when we can.

@DominicOram
Copy link
Contributor Author

Would it be good to have a line break between each device doc?

Yes, I agree, I have added. I think having it configurable is overkill though.

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 a dodal describe ixx to get information about what is on the beamline

4 participants