Skip to content

Commit

Permalink
docs change
Browse files Browse the repository at this point in the history
  • Loading branch information
dudanov committed May 29, 2024
1 parent ed19b0b commit 8b1c797
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pyftms/client/backends/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ class TrainingStatusEvent(NamedTuple):
"""Training Status Event."""

event_id: Literal["training_status"]
"""Event ID: always `training_status`."""
"""Always `training_status`."""
event_data: TrainingStatusEventData
"""`TrainingStatusEvent` data."""

Expand All @@ -312,7 +312,7 @@ class UpdateEvent(NamedTuple):
"""Update Event."""

event_id: Literal["update"]
"""Event ID: always `update`."""
"""Always `update`."""
event_data: UpdateEventData
"""`UpdateEvent` data."""

Expand All @@ -321,7 +321,7 @@ class SpinDownEvent(NamedTuple):
"""Spin Down Procedure Event."""

event_id: Literal["spin_down"]
"""Event ID: always `spin_down`."""
"""Always `spin_down`."""
event_data: SpinDownEventData
"""`SpinDownEvent` data."""

Expand All @@ -330,7 +330,7 @@ class SetupEvent(NamedTuple):
"""Setting Event."""

event_id: Literal["setup"]
"""Event ID: always `setup`."""
"""Always `setup`."""
event_data: SetupEventData
"""`SetupEvent` data."""
event_source: ControlSource
Expand All @@ -341,7 +341,7 @@ class ControlEvent(NamedTuple):
"""Control Event."""

event_id: ControlEvents
"""Simple Event ID."""
"""One of: `start`, `stop`, `pause`, `reset`."""
event_source: ControlSource
"""Reason of event."""

Expand Down

0 comments on commit 8b1c797

Please sign in to comment.