Fix wrong arguments in docstrings

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

Author: llucax

benchmarks/timeseries/periodic_feature_extractor.py

@@ -168,7 +168,7 @@ def run_avg_np(
         The return value is discarded such that it can be used by timit.
 
         Args:
-            a: The array containing all data.
+            array: The array containing all data.
             window_size: The size of the window.
             feature_extractor: An instance of the PeriodicFeatureExtractor.
         """
@@ -185,7 +185,7 @@ def run_avg_py(
         The return value is discarded such that it can be used by timit.
 
         Args:
-            a: The array containing all data.
+            array: The array containing all data.
             window_size: The size of the window.
             feature_extractor: An instance of the PeriodicFeatureExtractor.
         """

tests/actor/power_distributing/test_distribution_algorithm.py

@@ -50,8 +50,7 @@ def battery_msg(  # pylint: disable=too-many-arguments
         component_id: id of that component
         capacity: capacity
         soc: soc
-        power_supply: supply bound
-        power_consumption: consumption bound
+        power: power bounds
         timestamp: timestamp of the message
 
     Returns:
@@ -80,8 +79,7 @@ def inverter_msg(
 
     Args:
         component_id: id of that component
-        power_supply: Supply bound
-        power_consumption: Consumption bound inverter
+        power: Power bounds
         timestamp: Timestamp from the message
 
     Returns:
@@ -109,9 +107,7 @@ def create_components(
         num: Number of components
         capacity: Capacity for each battery
         soc: SoC for each battery
-        soc_bounds: SoC bounds for each battery
-        supply_bounds: Supply bounds for each battery and inverter
-        consumption_bounds: Consumption bounds for each battery and inverter
+        power: Power bounds for each battery and inverter
 
     Returns:
         List of the components

tests/actor/test_battery_pool_status.py

@@ -28,7 +28,7 @@ async def test_batteries_status(self, mocker: MockerFixture) -> None:
         BatteryStatusTracker is more tested in its own unit tests.
 
         Args:
-            mock_microgrid: mock microgrid client
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)

tests/actor/test_battery_status.py

@@ -155,7 +155,7 @@ async def test_sync_update_status_with_messages(
         Otherwise we would have lots of async calls and waiting.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)
@@ -317,7 +317,7 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
         Otherwise we would have lots of async calls and waiting.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)
@@ -434,7 +434,7 @@ async def test_sync_blocking_interrupted_with_with_max_data(
         Otherwise we would have lots of async calls and waiting.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)
@@ -485,7 +485,7 @@ async def test_sync_blocking_interrupted_with_invalid_message(
         Otherwise we would have lots of async calls and waiting.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)
@@ -545,8 +545,7 @@ async def test_timers(self, mocker: MockerFixture) -> None:
         Otherwise we would have lots of async calls and waiting.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
-            mocker: pytest mocker instance
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)
@@ -608,7 +607,7 @@ async def test_async_battery_status(self, mocker: MockerFixture) -> None:
         """Test if status changes.
 
         Args:
-            mock_microgrid: mock_microgrid fixture
+            mocker: Pytest mocker fixture.
         """
         mock_microgrid = MockMicrogrid(grid_meter=True)
         mock_microgrid.add_batteries(3)

tests/timeseries/_battery_pool/test_battery_pool.py

@@ -301,7 +301,7 @@ async def test_battery_pool_capacity(setup_batteries_pool: SetupArgs) -> None:
     """Test capacity metric for battery pool with subset of components in the microgrid.
 
     Args:
-        setup_all_batteries: Fixture that creates needed microgrid tools.
+        setup_batteries_pool: Fixture that creates needed microgrid tools.
     """
     await run_capacity_test(setup_batteries_pool)
 
@@ -319,7 +319,7 @@ async def test_battery_pool_soc(setup_batteries_pool: SetupArgs) -> None:
     """Test soc metric for battery pool with subset of components in the microgrid.
 
     Args:
-        setup_all_batteries: Fixture that creates needed microgrid tools.
+        setup_batteries_pool: Fixture that creates needed microgrid tools.
     """
     await run_soc_test(setup_batteries_pool)
 
@@ -337,7 +337,7 @@ async def test_battery_pool_power_bounds(setup_batteries_pool: SetupArgs) -> Non
     """Test power bounds metric for battery pool with subset of components in the microgrid.
 
     Args:
-        setup_all_batteries: Fixture that creates needed microgrid tools.
+        setup_batteries_pool: Fixture that creates needed microgrid tools.
     """
     await run_power_bounds_test(setup_batteries_pool)
 
@@ -355,7 +355,7 @@ async def test_battery_pool_temperature(setup_batteries_pool: SetupArgs) -> None
     """Test temperature for battery pool with subset of components in the microgrid.
 
     Args:
-        setup_all_batteries: Fixture that creates needed microgrid tools.
+        setup_batteries_pool: Fixture that creates needed microgrid tools.
     """
     await run_temperature_test(setup_batteries_pool)
 

tests/timeseries/mock_microgrid.py

@@ -465,7 +465,7 @@ async def send_battery_data(self, socs: list[float]) -> None:
         """Send raw battery data from the mock microgrid.
 
         Args:
-            values: list of soc values for each battery.
+            socs: list of soc values for each battery.
         """
         assert len(socs) == len(self.battery_ids)
         timestamp = datetime.now(tz=timezone.utc)

tests/utils/graph_generator.py

@@ -186,7 +186,7 @@ def _to_graph(
 
         Args:
             parent: the parent component.
-            components: the components to convert to a graph.
+            children: the children components.
 
         Returns:
             a tuple containing the components and connections of the graph.

tests/utils/mock_microgrid_client.py

@@ -229,9 +229,9 @@ def _create_mock_api(
         """Create mock of MicrogridApiClient.
 
         Args:
-            bat_channel: battery channels to be returned from
+            bat_channels: battery channels to be returned from
                 MicrogridApiClient.battery_data.
-            inv_channel: inverter channels to be returned from
+            inv_channels: inverter channels to be returned from
                 MicrogridApiClient.inverter_data.
             meter_channels: meter channels to be returned from
                 MicrogridApiClient.meter_data.