Apply suggestions from code review comments

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

Author: shsms

src/frequenz/sdk/actor/power_distributing/_component_pool_status_tracker.py

@@ -81,7 +81,7 @@ async def join(self) -> None:
         await self._task
 
     async def stop(self) -> None:
-        """Stop tracking batteries status."""
+        """Stop the ComponentPoolStatusTracker instance."""
         await cancel_and_await(self._task)
         await asyncio.gather(
             *[tracker.stop() for tracker in self._component_status_trackers],
@@ -134,21 +134,21 @@ async def _update_status(self) -> None:
             await self._component_status_sender.send(self._current_status)
 
     async def update_status(
-        self, succeed_components: set[int], failed_components: set[int]
+        self, succeeded_components: set[int], failed_components: set[int]
     ) -> None:
-        """Notify which components succeed and failed in the request.
+        """Notify which components succeeded or failed in the request.
 
         Components that failed will be considered as broken and will be temporarily
-        blocked for some time.
+        blocked.
 
-        Components that succeed will be unblocked.
+        Components that succeeded will be unblocked.
 
         Args:
-            succeed_components: Components that succeed request
-            failed_components: Components that failed request
+            succeeded_components: Component IDs for which the power request succeeded.
+            failed_components: Component IDs for which the power request failed.
         """
         await self._set_power_result_sender.send(
-            SetPowerResult(succeeded=succeed_components, failed=failed_components)
+            SetPowerResult(succeeded=succeeded_components, failed=failed_components)
         )
 
     def get_working_components(self, components: abc.Set[int]) -> abc.Set[int]:

src/frequenz/sdk/actor/power_distributing/_component_status.py

@@ -92,7 +92,7 @@ def __init__(  # pylint: disable=too-many-arguments
         """Create class instance.
 
         Args:
-            component_id: Id of this battery
+            component_id: Id of this component
             max_data_age_sec: If component stopped sending data, then
                 this is the maximum time when its last message should be considered as
                 valid. After that time, component won't be used until it starts sending
@@ -106,4 +106,4 @@ def __init__(  # pylint: disable=too-many-arguments
 
     @abstractmethod
     async def stop(self) -> None:
-        """Stop tracking battery status."""
+        """Stop the ComponentStatusTracker instance."""

tests/actor/test_battery_pool_status.py

@@ -94,13 +94,13 @@ async def test_batteries_status(self, mocker: MockerFixture) -> None:
         assert msg == batteries_status._current_status
 
         await batteries_status.update_status(
-            succeed_components={9}, failed_components={19, 29}
+            succeeded_components={9}, failed_components={19, 29}
         )
         await asyncio.sleep(0.1)
         assert batteries_status.get_working_components(batteries) == {9}
 
         await batteries_status.update_status(
-            succeed_components={9, 19}, failed_components=set()
+            succeeded_components={9, 19}, failed_components=set()
         )
         await asyncio.sleep(0.1)
         assert batteries_status.get_working_components(batteries) == {9, 19}