Skip to content

Commit 79ecc0d

Browse files
committed
Update BatteryPool.propose_power docstring to be less ambiguous
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent 9eabfb5 commit 79ecc0d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,10 @@ async def propose_power(
107107
its priority.
108108
109109
Args:
110-
power: The power to propose for the batteries in the pool. If None, the
111-
proposed power of higher priority actors will take precedence as the
112-
target power.
110+
power: The power to propose for the batteries in the pool. If `None`, this
111+
proposal will not have any effect on the target power, unless bounds are
112+
specified. If both are `None`, it is equivalent to not having a
113+
proposal or withdrawing a previous one.
113114
request_timeout: The timeout for the request.
114115
include_broken_batteries: if True, the power will be set for all batteries
115116
in the pool, including the broken ones. If False, then the power will be

0 commit comments

Comments
 (0)