From 72e0575deb036676846da8cf0c6212e6a3b6de34 Mon Sep 17 00:00:00 2001 From: Sahas Subramanian Date: Thu, 28 Mar 2024 15:04:46 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Leandro Lucarella Signed-off-by: Sahas Subramanian --- .../power_distributing/_component_managers/_battery_manager.py | 2 +- .../_component_managers/_ev_charger_manager/_states.py | 2 +- .../_component_status/_ev_charger_status_tracker.py | 2 +- src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py | 2 +- .../sdk/timeseries/ev_charger_pool/_system_bounds_tracker.py | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py b/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py index 27643e998..8b5f1cba0 100644 --- a/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py +++ b/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py @@ -129,7 +129,7 @@ def __init__( component_pool_status_sender: Sender[ComponentPoolStatus], results_sender: Sender[Result], ): - """Initialize the battery data manager. + """Initialize this instance. Args: component_pool_status_sender: Channel sender to send the status of the diff --git a/src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_states.py b/src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_states.py index ed416ae1d..c698bbaa2 100644 --- a/src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_states.py +++ b/src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_states.py @@ -75,7 +75,7 @@ class EvcStates: _states: dict[int, EvcState] def __init__(self) -> None: - """Initialize the EvcStates object.""" + """Initialize this instance.""" self._states = {} def get_ev_total_used_power(self) -> Power: diff --git a/src/frequenz/sdk/actor/power_distributing/_component_status/_ev_charger_status_tracker.py b/src/frequenz/sdk/actor/power_distributing/_component_status/_ev_charger_status_tracker.py index 1f887e8e3..a53575d83 100644 --- a/src/frequenz/sdk/actor/power_distributing/_component_status/_ev_charger_status_tracker.py +++ b/src/frequenz/sdk/actor/power_distributing/_component_status/_ev_charger_status_tracker.py @@ -52,7 +52,7 @@ def __init__( # pylint: disable=too-many-arguments status_sender: Sender[ComponentStatus], set_power_result_receiver: Receiver[SetPowerResult], ) -> None: - """Create an `EVChargerStatusTracker` instance. + """Initialize this instance. Args: component_id: ID of the EV charger to monitor the status of. diff --git a/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py b/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py index 6963c9fec..f909af661 100644 --- a/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py +++ b/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py @@ -229,5 +229,5 @@ async def stop(self) -> None: @property def _system_power_bounds(self) -> ReceiverFetcher[SystemBounds]: - """Return a receiver for the system power bounds.""" + """Return a receiver fetcher for the system power bounds.""" return self._ev_charger_pool.bounds_channel diff --git a/src/frequenz/sdk/timeseries/ev_charger_pool/_system_bounds_tracker.py b/src/frequenz/sdk/timeseries/ev_charger_pool/_system_bounds_tracker.py index f2b049cc0..4d18309ed 100644 --- a/src/frequenz/sdk/timeseries/ev_charger_pool/_system_bounds_tracker.py +++ b/src/frequenz/sdk/timeseries/ev_charger_pool/_system_bounds_tracker.py @@ -36,7 +36,7 @@ def __init__( status_receiver: Receiver[ComponentPoolStatus], bounds_sender: Sender[SystemBounds], ): - """Initialize the system bounds tracker. + """Initialize this instance. Args: component_ids: The ids of the components to track.