Skip to content

Commit 44393a6

Browse files
committed
add note in docs
1 parent 2d011f2 commit 44393a6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/plan_stubs/redefining.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def my_plan():
3131
## `redefine_refl_parameter`
3232

3333
The {py:obj}`ibex_bluesky_core.plan_stubs.redefine_refl_parameter` plan stub can be used to redefine the current
34-
position of a {py:obj}`ibex_bluesky_core.devices.reflectometry.ReflParameter` to a new value.
34+
position of a {py:obj}`ibex_bluesky_core.devices.reflectometry.ReflParameter` to a new value. Note that some reflectometry parameters ie. `Theta` cannot be redefined, so these must be constructed with `has_redefine=False`. This plan stub will handle this case and raise an error if a user tries to redefine it.
3535

3636
This plan stub has an identical API to that of the {py:obj}`ibex_bluesky_core.plan_stubs.redefine_motor` plan stub
3737
described above, but operates on a reflectometry parameter rather than a motor.

0 commit comments

Comments
 (0)