Skip to content

Commit 625378b

Browse files
committed
Remove *Pool constructor related docs from the class docs
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent fdc452c commit 625378b

File tree

5 files changed

+2
-17
lines changed

5 files changed

+2
-17
lines changed

src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@ def _parse_result(
672672
battery_ids,
673673
request_timeout.total_seconds(),
674674
)
675-
except Exception as e:
675+
except Exception as e: # pylint: disable=broad-except
676676
failed_power += distribution[inverter_id]
677677
failed_batteries = failed_batteries.union(battery_ids)
678678
_logger.warning(

src/frequenz/sdk/actor/power_distributing/_component_managers/_pv_inverter_manager/_pv_inverter_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ async def distribute_power(self, request: Request) -> None:
161161

162162
async def _set_api_power(
163163
self, request: Request, allocations: dict[int, Power], remaining_power: Power
164-
) -> None:
164+
) -> None: # pylint: disable=too-many-locals
165165
api_client = connection_manager.get().api_client
166166
tasks: dict[int, asyncio.Task[None]] = {}
167167
for component_id, power in allocations.items():

src/frequenz/sdk/timeseries/battery_pool/_battery_pool.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,6 @@
4040
class BatteryPool:
4141
"""An interface for interaction with pools of batteries.
4242
43-
!!! note
44-
`BatteryPool` instances are not meant to be created directly by users. Use the
45-
[`microgrid.battery_pool`][frequenz.sdk.microgrid.battery_pool] method for
46-
creating `BatteryPool` instances.
47-
4843
Provides:
4944
- properties for fetching reporting streams of instantaneous
5045
[power][frequenz.sdk.timeseries.battery_pool.BatteryPool.power],

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,6 @@ class EVChargerPoolError(Exception):
3232
class EVChargerPool:
3333
"""An interface for interaction with pools of EV Chargers.
3434
35-
!!! note
36-
`EVChargerPool` instances are not meant to be created directly by users. Use the
37-
[`microgrid.ev_charger_pool`][frequenz.sdk.microgrid.ev_charger_pool] method for
38-
creating `EVChargerPool` instances.
39-
4035
Provides:
4136
- Aggregate [`power`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.power]
4237
and 3-phase

src/frequenz/sdk/timeseries/pv_pool/_pv_pool.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ class PVPoolError(Exception):
2727
class PVPool:
2828
"""An interface for interaction with pools of PV inverters.
2929
30-
!!! note
31-
`PVPool` instances are not meant to be created directly by users. Use the
32-
[`microgrid.pv_pool`][frequenz.sdk.microgrid.pv_pool] method for creating
33-
`PVPool` instances.
34-
3530
Provides:
3631
- Aggregate [`power`][frequenz.sdk.timeseries.pv_pool.PVPool.power]
3732
measurements of the PV inverters in the pool.

0 commit comments

Comments
 (0)