Skip to content

Commit 00f14e7

Browse files
llucaxshsms
andcommitted
Improve wording for UNKNOWN states
The original wording comes from the API specs docs (for example https://github.com/frequenz-floss/frequenz-api-microgrid/blob/2332734e86dd8c1d3bf4ee601b93d52525654a6f/proto/frequenz/api/microgrid/inverter.proto#L70-L72), but we change the wording here to make it more clear. Co-authored-by: Sahas Subramanian <[email protected]> Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 0fc5711 commit 00f14e7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/frequenz/client/microgrid/_component_states.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class BatteryComponentState(Enum):
4949
"""The battery is switching off and needs some time to fully shut down."""
5050

5151
UNKNOWN = battery.ComponentState.COMPONENT_STATE_UNKNOWN
52-
"""The state is provided by the device, but it is not one of the above states."""
52+
"""A state is provided by the component, but it is not one of the above states."""
5353

5454
@classmethod
5555
def from_pb(cls, state: battery.ComponentState) -> Self:
@@ -176,7 +176,7 @@ class EVChargerComponentState(Enum):
176176
"""The component is interrupted."""
177177

178178
UNKNOWN = ev_charger.ComponentState.COMPONENT_STATE_UNKNOWN
179-
"""The state is provided by the device, but it is not one of the above states."""
179+
"""A state is provided by the component, but it is not one of the above states."""
180180

181181
@classmethod
182182
def from_pb(cls, state: ev_charger.ComponentState) -> Self:
@@ -237,7 +237,7 @@ class InverterComponentState(Enum):
237237
"""
238238

239239
UNKNOWN = inverter.ComponentState.COMPONENT_STATE_UNKNOWN
240-
"""The state is provided by the device, but it is not one of the above states."""
240+
"""A state is provided by the component, but it is not one of the above states."""
241241

242242
@classmethod
243243
def from_pb(cls, state: inverter.ComponentState) -> Self:

0 commit comments

Comments
 (0)