Skip to content

Commit 9eabfb5

Browse files
committed
Add more cross-referencing in BatteryPool docstrings
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent f268d16 commit 9eabfb5

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

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

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,9 @@ async def propose_power(
102102
system power bounds for the batteries.
103103
104104
The result of the request can be accessed using the receiver returned from the
105-
`power_status` method, which also streams the bounds that an actor should
106-
comply with, based on its priority.
105+
[`power_status`][frequenz.sdk.timeseries.battery_pool.BatteryPool.power_status]
106+
method, which also streams the bounds that an actor should comply with, based on
107+
its priority.
107108
108109
Args:
109110
power: The power to propose for the batteries in the pool. If None, the
@@ -144,16 +145,18 @@ async def propose_charge(
144145
145146
Power values need to be positive values, indicating charge power.
146147
147-
When using the Passive Sign Convention, the `propose_power` method might be more
148-
convenient.
148+
When using the Passive Sign Convention, the
149+
[`propose_power`][frequenz.sdk.timeseries.battery_pool.BatteryPool.propose_power]
150+
method might be more convenient.
149151
150152
If the same batteries are shared by multiple actors, the behaviour is the same
151153
as that of the `propose_power` method. The bounds for lower priority actors
152154
can't be specified with this method. If that's required, use the
153155
`propose_power` method instead.
154156
155-
The result of the request can be accessed using the receiver returned from
156-
the `power_status` method.
157+
The result of the request can be accessed using the receiver returned from the
158+
[`power_status`][frequenz.sdk.timeseries.battery_pool.BatteryPool.power_status]
159+
method.
157160
158161
Args:
159162
power: The unsigned charge power to propose for the batteries in the pool.
@@ -194,16 +197,18 @@ async def propose_discharge(
194197
195198
Power values need to be positive values, indicating discharge power.
196199
197-
When using the Passive Sign Convention, the `propose_power` method might be more
198-
convenient.
200+
When using the Passive Sign Convention, the
201+
[`propose_power`][frequenz.sdk.timeseries.battery_pool.BatteryPool.propose_power]
202+
method might be more convenient.
199203
200204
If the same batteries are shared by multiple actors, the behaviour is the same
201205
as that of the `propose_power` method. The bounds for lower priority actors
202206
can't be specified with this method. If that's required, use the
203207
`propose_power` method instead.
204208
205-
The result of the request can be accessed using the receiver returned from
206-
the `power_status` method.
209+
The result of the request can be accessed using the receiver returned from the
210+
[`power_status`][frequenz.sdk.timeseries.battery_pool.BatteryPool.power_status]
211+
method.
207212
208213
Args:
209214
power: The unsigned discharge power to propose for the batteries in the

0 commit comments

Comments
 (0)