Fix capitalization for "EV Chargers" in docstrings and log messages

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/_ev_charger_current_formula.py

@@ -18,16 +18,16 @@ class EVChargerCurrentFormula(FormulaGenerator):
     """Create a formula engine from the component graph for calculating grid current."""
 
     async def generate(self) -> FormulaEngine3Phase:
-        """Generate a formula for calculating total ev current for given component ids.
+        """Generate a formula for calculating total EV current for given component ids.
 
         Returns:
-            A formula engine that calculates total 3-phase ev charger current values.
+            A formula engine that calculates total 3-phase EV Charger current values.
         """
         component_ids = self._config.component_ids
 
         if not component_ids:
             logger.warning(
-                "No ev charger component IDs specified. "
+                "No EV Charger component IDs specified. "
                 "Subscribing to the resampling actor with a non-existing "
                 "component id, so that `0` values are sent from the formula."
             )
@@ -72,7 +72,7 @@ async def _gen_phase_formula(
     ) -> FormulaEngine:
         builder = self._get_builder("ev-current", metric_id)
 
-        # generate a formula that just adds values from all ev-chargers.
+        # generate a formula that just adds values from all EV Chargers.
         for idx, component_id in enumerate(component_ids):
             if idx > 0:
                 builder.push_oper("+")

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/_ev_charger_power_formula.py

@@ -16,17 +16,17 @@ class EVChargerPowerFormula(FormulaGenerator):
     """Create a formula engine from the component graph for calculating grid power."""
 
     async def generate(self) -> FormulaEngine:
-        """Generate a formula for calculating total ev power for given component ids.
+        """Generate a formula for calculating total EV power for given component ids.
 
         Returns:
-            A formula engine that calculates total EV charger power values.
+            A formula engine that calculates total EV Charger power values.
         """
         builder = self._get_builder("ev-power", ComponentMetricId.ACTIVE_POWER)
 
         component_ids = self._config.component_ids
         if not component_ids:
             logger.warning(
-                "No ev charger component IDs specified. "
+                "No EV Charger component IDs specified. "
                 "Subscribing to the resampling actor with a non-existing "
                 "component id, so that `0` values are sent from the formula."
             )

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-"""Interactions with pools of ev chargers."""
+"""Interactions with pools of EV Chargers."""
 
 from __future__ import annotations
 
@@ -44,7 +44,7 @@ def __init__(
             resampler_subscription_sender: A sender for sending metric requests to the
                 resampling actor.
             component_ids: An optional list of component_ids belonging to this pool.  If
-                not specified, IDs of all ev chargers in the microgrid will be fetched
+                not specified, IDs of all EV Chargers in the microgrid will be fetched
                 from the component graph.
         """
         self._channel_registry = channel_registry
@@ -68,14 +68,14 @@ def __init__(
         )
 
     async def total_current(self) -> FormulaReceiver3Phase:
-        """Fetch the total current for the ev chargers in the pool.
+        """Fetch the total current for the EV Chargers in the pool.
 
-        If a formula engine to calculate ev charger current is not already
-        running, it will be started.  Else, we'll just get a new receiver to the
-        already existing data stream.
+        If a formula engine to calculate EV Charger current is not already running, it
+        will be started.  Else, we'll just get a new receiver to the already existing
+        data stream.
 
         Returns:
-            A *new* receiver that will stream ev_charger current values.
+            A *new* receiver that will stream EV Charger current values.
         """
         return await self._formula_pool.from_generator(
             "ev_charger_total_current",
@@ -84,14 +84,14 @@ async def total_current(self) -> FormulaReceiver3Phase:
         )
 
     async def total_power(self) -> FormulaReceiver:
-        """Fetch the total power for the ev chargers in the pool.
+        """Fetch the total power for the EV Chargers in the pool.
 
-        If a formula engine to calculate EV charger power is not already
+        If a formula engine to calculate EV Charger power is not already
         running, it will be started. Else, we'll just get a new receiver
         to the already existing data stream.
 
         Returns:
-            A *new* receiver that will stream ev_charger power values.
+            A *new* receiver that will stream EV Charger power values.
         """
         return await self._formula_pool.from_generator(
             "ev_charger_total_power",
@@ -100,14 +100,14 @@ async def total_power(self) -> FormulaReceiver:
         )
 
     async def current(self, component_id: int) -> FormulaReceiver3Phase:
-        """Fetch the 3-phase current for the given ev_charger id.
+        """Fetch the 3-phase current for the given EV Charger id.
 
         Args:
-            component_id: id of the ev charger to stream current values for.
+            component_id: id of the EV Charger to stream current values for.
 
         Returns:
             A *new* receiver that will stream 3-phase current values for the given
-                ev charger.
+                EV Charger.
 
         Raises:
             EVChargerPoolError: if the given component_id is not part of the pool.
@@ -124,13 +124,13 @@ async def current(self, component_id: int) -> FormulaReceiver3Phase:
         )
 
     async def power(self, component_id: int) -> FormulaReceiver:
-        """Fetch the power for the given ev_charger id.
+        """Fetch the power for the given EV Charger id.
 
         Args:
-            component_id: id of the ev charger to stream power values for.
+            component_id: id of the EV Charger to stream power values for.
 
         Returns:
-            A *new* receiver that will stream power values for the given ev charger.
+            A *new* receiver that will stream power values for the given EV Charger.
 
         Raises:
             EVChargerPoolError: if the given component_id is not part of the pool.

src/frequenz/sdk/timeseries/ev_charger_pool/_state_tracker.py

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""State tracking for ev charger pools."""
+"""State tracking for EV Charger pools."""
 
 from __future__ import annotations
 
@@ -57,21 +57,21 @@ def from_ev_charger_data(cls, data: EVChargerData) -> EVChargerState:
 
 @dataclass(frozen=True)
 class EVChargerPoolStates:
-    """States of all ev chargers in the pool."""
+    """States of all EV Chargers in the pool."""
 
     _states: dict[int, EVChargerState]
     _changed_component: Optional[int] = None
 
     def __iter__(self) -> Iterator[tuple[int, EVChargerState]]:
-        """Iterate over states of all ev chargers.
+        """Iterate over states of all EV Chargers.
 
         Returns:
-            An iterator over all ev charger states.
+            An iterator over all EV Charger states.
         """
         return iter(self._states.items())
 
     def latest_change(self) -> Optional[tuple[int, EVChargerState]]:
-        """Return the most recent ev charger state change.
+        """Return the most recent EV Charger state change.
 
         The first `EVChargerPoolStates` instance created by a `StateTracker` will just
         be a representation of the states of all EV Chargers.  At that point, the most
@@ -80,7 +80,7 @@ def latest_change(self) -> Optional[tuple[int, EVChargerState]]:
 
         Returns:
             None, when the most recent change is unknown.  Otherwise, a tuple with
-                the component ID of an ev charger that just had a state change, and its
+                the component ID of an EV Charger that just had a state change, and its
                 new state.
         """
         if self._changed_component is None:
@@ -94,13 +94,13 @@ def latest_change(self) -> Optional[tuple[int, EVChargerState]]:
 
 
 class StateTracker:
-    """A class for keeping track of the states of all ev chargers in a pool."""
+    """A class for keeping track of the states of all EV Chargers in a pool."""
 
     def __init__(self, component_ids: set[int]) -> None:
         """Create a `_StateTracker` instance.
 
         Args:
-            component_ids: ev charger component ids to track the states of.
+            component_ids: EV Charger component ids to track the states of.
         """
         self._component_ids = component_ids
         self._channel = Broadcast[EVChargerPoolStates](
@@ -111,7 +111,7 @@ def __init__(self, component_ids: set[int]) -> None:
         self._states: dict[int, EVChargerState] = {}
 
     def _get(self) -> EVChargerPoolStates:
-        """Get a representation of the current states of all ev chargers.
+        """Get a representation of the current states of all EV Chargers.
 
         Returns:
             An `EVChargerPoolStates` instance.
@@ -122,15 +122,15 @@ def _update(
         self,
         data: EVChargerData,
     ) -> Optional[EVChargerPoolStates]:
-        """Update the state of an ev charger, from a new data point.
+        """Update the state of an EV Charger, from a new data point.
 
         Args:
-            data: component data from the microgrid, for an ev charger in the pool.
+            data: component data from the microgrid, for an EV Charger in the pool.
 
         Returns:
-            A new `EVChargerPoolStates` instance representing all the ev chargers in
-                the pool, in case there has been a state change for any of the ev
-                chargers, or `None` otherwise.
+            A new `EVChargerPoolStates` instance representing all the EV Chargers in
+                the pool, in case there has been a state change for any of the EV
+                Chargers, or `None` otherwise.
         """
         evc_id = data.component_id
         new_state = EVChargerState.from_ev_charger_data(data)
@@ -163,7 +163,7 @@ def new_receiver(self) -> Receiver[EVChargerPoolStates]:
         """Return a receiver that streams ev charger states.
 
         Returns:
-            A receiver that streams the states of all ev chargers in the pool, every
+            A receiver that streams the states of all EV Chargers in the pool, every
                 time the states of any of them change.
         """
         if self._task is None or self._task.done():