Skip to content

fix(bl_state): correct docstring examples #926

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.

Sign up for GitHub

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

Merged
wyzula-jan merged 1 commit into from
May 29, 2026
Merged

fix(bl_state): correct docstring examples #926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions bec_lib/bec_lib/bl_states.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,8 +327,10 @@ class ShutterState(DeviceBeamlineState[DeviceStateConfig]):
A state that checks if the shutter is open.

Example:
shutter_state = ShutterState(name="shutter_open")
shutter_state.configure(device="shutter1")
shutter_state = DeviceStateConfig(
name="shutter_open",
device="shutter1",
)
bec.beamline_states.add(shutter_state)
"""

Expand All @@ -352,8 +354,14 @@ class DeviceWithinLimitsState(DeviceBeamlineState[DeviceWithinLimitsStateConfig]
A state that checks if a positioner is within limits.

Example:
device_state = DeviceWithinLimitsState(name="sample_x_within_limits")
device_state.configure(device="sample_x", signal="sample_x_signal_name", low_limit=0.0, high_limit=10.0)
device_state = DeviceWithinLimitsStateConfig(
name="samx_within_limits",
title="samx within 0-10",
device="samx",
signal="samx",
low_limit=0.0,
high_limit=10.0,
)
bec.beamline_states.add(device_state)

"""
Expand Down
Loading