Add missing arguments to docstrings

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

benchmarks/timeseries/periodic_feature_extractor.py

@@ -112,6 +112,7 @@ def _num_windows(
         Args:
             window: The buffer that is used for the average calculation.
             window_size: The size of the window in samples.
+            period: The distance between two succeeding intervals in samples.
 
         Returns:
             The number of windows that are fully contained in the MovingWindow.

tests/actor/test_actor.py

@@ -125,6 +125,7 @@ def __init__(
             name: Name of the actor.
             recv1: A channel receiver for test boolean data.
             recv2: A channel receiver for test boolean data.
+            output: A channel sender for output test boolean data.
         """
         super().__init__(name=name)
         self._recv1 = recv1
@@ -203,6 +204,7 @@ async def test_restart_on_unhandled_exception(
 
     Args:
         restart_limit: The restart limit to use.
+        caplog: The log capture fixture.
     """
     caplog.set_level("DEBUG", logger="frequenz.sdk.actor._actor")
     caplog.set_level("DEBUG", logger="frequenz.sdk.actor._run_utils")

tests/actor/test_battery_status.py

@@ -59,6 +59,7 @@ def battery_data(  # pylint: disable=too-many-arguments
         component_state: Component state.
             Defaults to BatteryState.COMPONENT_STATE_CHARGING.
         errors: List of the components error. By default empty list will be created.
+        capacity: Battery capacity.
 
     Returns:
         BatteryData with given arguments.

tests/timeseries/mock_microgrid.py

@@ -304,6 +304,7 @@ def add_chps(self, count: int, no_meters: bool = False) -> None:
 
         Args:
             count: number of CHPs to add.
+            no_meters: if True, do not add a meter for each CHP.
         """
         for _ in range(count):
             meter_id = self._id_increment * 10 + self.meter_id_suffix

tests/utils/graph_generator.py

@@ -185,6 +185,7 @@ def _to_graph(
         """Convert a list of components to a graph.
 
         Args:
+            parent: the parent component.
             components: the components to convert to a graph.
 
         Returns:

tests/utils/mock_microgrid_client.py

@@ -233,6 +233,10 @@ def _create_mock_api(
                 MicrogridApiClient.battery_data.
             inv_channel: inverter channels to be returned from
                 MicrogridApiClient.inverter_data.
+            meter_channels: meter channels to be returned from
+                MicrogridApiClient.meter_data.
+            ev_charger_channels: ev_charger channels to be returned from
+                MicrogridApiClient.ev_charger_data.
 
         Returns:
             Magic mock instance of MicrogridApiClient.
@@ -274,6 +278,7 @@ def _get_battery_receiver(
         Args:
             component_id: component_id
             channels: Broadcast channels
+            maxsize: Max size of the channel
 
         Returns:
             Receiver from the given channels.
@@ -293,6 +298,7 @@ def _get_meter_receiver(
         Args:
             component_id: component_id
             channels: Broadcast channels
+            maxsize: Max size of the channel
 
         Returns:
             Receiver from the given channels.
@@ -312,6 +318,7 @@ def _get_ev_charger_receiver(
         Args:
             component_id: component_id
             channels: Broadcast channels
+            maxsize: Max size of the channel
 
         Returns:
             Receiver from the given channels.
@@ -331,6 +338,7 @@ def _get_inverter_receiver(
         Args:
             component_id: component_id
             channels: Broadcast channels
+            maxsize: Max size of the channel
 
         Returns:
             Receiver from the given channels.