Skip to content

Commit af20290

Browse files
committed
Improve documentation of optional arguments in DataPipeline methods
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent 6eb1305 commit af20290

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/frequenz/sdk/microgrid/_data_pipeline.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,8 @@ def ev_charger_pool(ev_charger_ids: set[int] | None = None) -> EVChargerPool:
301301
302302
Args:
303303
ev_charger_ids: Optional set of IDs of EV Chargers to be managed by the
304-
EVChargerPool.
304+
EVChargerPool. If not specified, all EV Chargers available in the
305+
component graph are used.
305306
306307
Returns:
307308
An EVChargerPool instance.
@@ -317,7 +318,8 @@ def battery_pool(battery_ids: abc.Set[int] | None = None) -> BatteryPool:
317318
318319
Args:
319320
battery_ids: Optional set of IDs of batteries to be managed by the
320-
BatteryPool.
321+
BatteryPool. If not specified, all batteries available in the
322+
component graph are used.
321323
322324
Returns:
323325
A BatteryPool instance.

0 commit comments

Comments
 (0)