Skip to content

Commit

Permalink
new doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
parfa30 committed Sep 6, 2024
1 parent a8eefe3 commit a9381e8
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions python/lsst/ts/observatory/control/utils/enums.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,29 @@ class CalibrationType(enum.IntEnum):

# TODO: (DM-46168) Revert workaround for TunableLaser XML changes
class LaserOpticalConfiguration(enum.StrEnum):
"""Configuration of the optical output"""
"""Configuration of the optical output
Attributes
----------
SCU: `str`
Pass the beam straight-through the SCU.
F1_SCU: `str`
Direct the beam through the F1 after passing through the SCU.
F2_SCU: `str`
Direct the beam through the F2 after passing through the SCU.
NO_SCU: `str`
Pass the beam straight-through.
F1_NO_SCU: `str`
Pass the beam to F1 output.
F2_NO_SCU: `str`
Pass the beam to F2 output.
"""

SCU = "SCU"
"""Pass the beam straight-through the SCU."""
F1_SCU = "F1 SCU"
"""Direct the beam through the F1 after passing through the SCU."""
F2_SCU = "F2 SCU"
"""Direct the beam through the F2 after passing through the SCU."""
NO_SCU = "No SCU"
"""Pass the beam straight-through."""
F1_NO_SCU = "F1 No SCU"
"""Pass the beam to F1 output."""
F2_NO_SCU = "F2 No SCU"
"""Pass the beam to F2 output."""

0 comments on commit a9381e8

Please sign in to comment.