fix(scans): supply ScanArgument example= for fermat scans' generated docs

The generated `Examples:` section in scans.<name>? always replaces any
hand-written docstring example with placeholder values, using a generic
1.0 for required float args with no example hint. Set example= on the
required fovx/fovy/cenx/ceny/step/zshift/angle arguments of
flomni_fermat_scan, omny_fermat_scan, and lamni_fermat_scan so the
generated Minimum/Full calls show sensible values instead. Also drop the
now-fully-dead hand-written Examples: blocks in flomni/omny, since they
were always discarded before reaching users.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0197yD3hTxwvrgmYr7aaYiCD

csaxs_bec/scans/flomni_fermat_scan.py

@@ -69,13 +69,13 @@ class FlomniFermatScan(ScanBase):
     def __init__(
         # fmt: off
         self,
-        fovx: Annotated[float, ScanArgument(display_name="Fovx", description="FOV in the piezo plane (i.e. piezo range). Max 200 um.", units=Units.µm, gt=0, lt=200)],
-        fovy: Annotated[float, ScanArgument(display_name="Fovy", description="FOV in the piezo plane (i.e. piezo range). Max 100 um.", units=Units.µm, gt=0, lt=100)],
-        cenx: Annotated[float, ScanArgument(display_name="Cenx", description="Center position in x.", units=Units.µm)],
-        ceny: Annotated[float, ScanArgument(display_name="Ceny", description="Center position in y.", units=Units.µm)],
-        step: Annotated[float, ScanArgument(display_name="Step", description="Step size.", units=Units.µm)],
-        zshift: Annotated[float, ScanArgument(display_name="Zshift", description="Shift in z. ", units=Units.µm)],
-        angle: Annotated[float, ScanArgument(display_name="Angle", description="Rotation angle (will rotate first)", units=Units.deg)],
+        fovx: Annotated[float, ScanArgument(display_name="Fovx", description="FOV in the piezo plane (i.e. piezo range). Max 200 um.", units=Units.µm, gt=0, lt=200, example=10)],
+        fovy: Annotated[float, ScanArgument(display_name="Fovy", description="FOV in the piezo plane (i.e. piezo range). Max 100 um.", units=Units.µm, gt=0, lt=100, example=10)],
+        cenx: Annotated[float, ScanArgument(display_name="Cenx", description="Center position in x.", units=Units.µm, example=0)],
+        ceny: Annotated[float, ScanArgument(display_name="Ceny", description="Center position in y.", units=Units.µm, example=0)],
+        step: Annotated[float, ScanArgument(display_name="Step", description="Step size.", units=Units.µm, example=1)],
+        zshift: Annotated[float, ScanArgument(display_name="Zshift", description="Shift in z. ", units=Units.µm, example=0)],
+        angle: Annotated[float, ScanArgument(display_name="Angle", description="Rotation angle (will rotate first)", units=Units.deg, example=0)],
         corridor_size: Annotated[float | None, ScanArgument(display_name="Corridor Size", description="Corridor size for the corridor optimization.", units=Units.µm)] = None,
         exp_time: DefaultArgType.ExposureTime = 0,
         frames_per_trigger: DefaultArgType.FramesPerTrigger = 1,
@@ -101,9 +101,6 @@ class FlomniFermatScan(ScanBase):
 
         Returns:
             ScanReport
-
-        Examples:
-            >>> scans.flomni_fermat_scan(10, 10, 0, 0, 1, 0, 0, exp_time=0.1, frames_per_trigger=1, burst_at_each_point=1)
         """
         super().__init__(**kwargs)
         self._baseline_readout_status = None

csaxs_bec/scans/lamni_fermat_scan.py

@@ -67,9 +67,9 @@ class LamniFermatScan(ScanBase):
     def __init__(
         # fmt: off
         self,
-        fovx: Annotated[float, ScanArgument(display_name="FOV x", description="FOV in the piezo plane (i.e. piezo range). Max 80 um", units=Units.µm, gt=0, lt=80)],
-        fovy: Annotated[float, ScanArgument(display_name="FOV y", description="FOV in the piezo plane (i.e. piezo range). Max 80 um", units=Units.µm, gt=0, lt=80)],
-        step: Annotated[float, ScanArgument(display_name="Step", description="Step size", units=Units.µm)],
+        fovx: Annotated[float, ScanArgument(display_name="FOV x", description="FOV in the piezo plane (i.e. piezo range). Max 80 um", units=Units.µm, gt=0, lt=80, example=10)],
+        fovy: Annotated[float, ScanArgument(display_name="FOV y", description="FOV in the piezo plane (i.e. piezo range). Max 80 um", units=Units.µm, gt=0, lt=80, example=10)],
+        step: Annotated[float, ScanArgument(display_name="Step", description="Step size", units=Units.µm, example=1)],
         shift_x: Annotated[float, ScanArgument(display_name="Shift X", description="Extra shift in x. The shift is directly applied to the scan. It will not be auto-rotated.", units=Units.mm)] = 0,
         shift_y: Annotated[float, ScanArgument(display_name="Shift Y", description="Extra shift in y. The shift is directly applied to the scan. It will not be auto-rotated.", units=Units.mm)] = 0,
         center_x: Annotated[float, ScanArgument(display_name="Center X", description="Center position in x at 0 deg. This shift is rotated using the geometry of LamNI. It is determined by the first 'click' in the x-ray eye alignment procedure.", units=Units.mm)] = 0,

csaxs_bec/scans/omny_fermat_scan.py

@@ -61,12 +61,12 @@ class OmnyFermatScan(ScanBase):
     def __init__(
         # fmt: off
         self,
-        fovx: Annotated[float, ScanArgument(display_name="Fovx", description="FOV in the piezo plane (i.e. piezo range).", units=Units.µm, gt=0, lt=200)],
-        fovy: Annotated[float, ScanArgument(display_name="Fovy", description="FOV in the piezo plane (i.e. piezo range).", units=Units.µm, gt=0, lt=100)],
-        cenx: Annotated[float, ScanArgument(display_name="Cenx", description="Center position in x.", units=Units.µm)],
-        ceny: Annotated[float, ScanArgument(display_name="Ceny", description="Center position in y.", units=Units.µm)],
-        step: Annotated[float, ScanArgument(display_name="Step", description="Step size.", units=Units.µm)],
-        zshift: Annotated[float, ScanArgument(display_name="Zshift", description="Shift in z.", units=Units.µm)],
+        fovx: Annotated[float, ScanArgument(display_name="Fovx", description="FOV in the piezo plane (i.e. piezo range).", units=Units.µm, gt=0, lt=200, example=10)],
+        fovy: Annotated[float, ScanArgument(display_name="Fovy", description="FOV in the piezo plane (i.e. piezo range).", units=Units.µm, gt=0, lt=100, example=10)],
+        cenx: Annotated[float, ScanArgument(display_name="Cenx", description="Center position in x.", units=Units.µm, example=0)],
+        ceny: Annotated[float, ScanArgument(display_name="Ceny", description="Center position in y.", units=Units.µm, example=0)],
+        step: Annotated[float, ScanArgument(display_name="Step", description="Step size.", units=Units.µm, example=1)],
+        zshift: Annotated[float, ScanArgument(display_name="Zshift", description="Shift in z.", units=Units.µm, example=0)],
         angle: Annotated[float | None, ScanArgument(display_name="Angle", description="Rotation angle (will rotate first)", units=Units.deg)] = None,
         corridor_size: Annotated[float, ScanArgument(display_name="Corridor Size", description="Corridor size for the corridor optimization. ", units=Units.µm)] = 3,
         exp_time: DefaultArgType.ExposureTime = 0,
@@ -93,9 +93,6 @@ class OmnyFermatScan(ScanBase):
 
         Returns:
             ScanReport
-
-        Examples:
-            >>> scans.omny_fermat_scan(10, 10, 0, 0, 1, 0, 0, exp_time=0.1, frames_per_trigger=1, readout_time=0)
         """
         super().__init__(**kwargs)
         self._baseline_readout_status = None