Skip to content

docs: add a note to injecting multiple devices docs#1525

Open
noemifrisina wants to merge 5 commits intomainfrom
add-note-for-inject
Open

docs: add a note to injecting multiple devices docs#1525
noemifrisina wants to merge 5 commits intomainfrom
add-note-for-inject

Conversation

@noemifrisina
Copy link
Copy Markdown
Contributor

From the documentation page it wasn't obvious that the DeviceComposite would need to be imported into the same planFunctions module that will need to make use of it, so adding a small note.
This led to multiple pydantic errors on the beamline that did not help understanding what the actual problem was (issue tbd)

@noemifrisina noemifrisina requested a review from a team as a code owner April 28, 2026 13:15
@noemifrisina noemifrisina added the documentation Improvements or additions to documentation label Apr 28, 2026
Comment thread docs/how-to/write-plans.md Outdated
Comment thread docs/how-to/write-plans.md Outdated
```

> [!NOTE]
> In order for this to work, the `MyDeviceComposite` needs to be mae available to blueapi by importing it into the `planFunctions` module where it's needed.
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.

Suggested change
> In order for this to work, the `MyDeviceComposite` needs to be mae available to blueapi by importing it into the `planFunctions` module where it's needed.
> In order for this to work, the `MyDeviceComposite` needs to be made available to blueapi by importing it into the `planFunctions` module where it's needed. Factories for the individual devices within the composite also need to be available in the relevant beamline device module.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.30%. Comparing base (8820bbe) to head (8462f9d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1525   +/-   ##
=======================================
  Coverage   95.30%   95.30%           
=======================================
  Files          43       43           
  Lines        3198     3198           
=======================================
  Hits         3048     3048           
  Misses        150      150           

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

noemifrisina and others added 2 commits April 28, 2026 16:28
Co-authored-by: Zoheb Shaikh <zoheb.shaikh@diamond.ac.uk>
@noemifrisina noemifrisina changed the title Add a note to injecting multiple devices docs docs: add a note to injecting multiple devices docs Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants