fix(bl_state): correct docstring examples#926
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Docstring-only update correcting the usage examples for ShutterState and DeviceWithinLimitsState in bl_states.py to reflect the actual public API (bec.beamline_states.add(<Config>)) instead of the old direct-instantiation/configure(...) pattern.
Changes:
- Updated
ShutterStatedocstring example to construct aDeviceStateConfigand pass it tobec.beamline_states.add(...). - Updated
DeviceWithinLimitsStatedocstring example to construct aDeviceWithinLimitsStateConfigwith the relevant fields and pass it tobec.beamline_states.add(...).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Update of doctring examples.