File tree Expand file tree Collapse file tree 1 file changed +9
-2
lines changed
src/frequenz/sdk/timeseries/battery_pool Expand file tree Collapse file tree 1 file changed +9
-2
lines changed Original file line number Diff line number Diff line change 3939class BatteryPool :
4040 """An interface for interaction with pools of batteries.
4141
42- Use the [microgrid.battery_pool][frequenz.sdk.microgrid.battery_pool] method for
43- creating `BatteryPool` instances.
42+ !!! note
43+ `BatteryPool` instances are not meant to be created directly by users. Use the
44+ [`microgrid.battery_pool`][frequenz.sdk.microgrid.battery_pool] method for
45+ creating `BatteryPool` instances.
4446
4547 Provides:
4648 - properties for fetching reporting streams of instantaneous
@@ -63,6 +65,11 @@ def __init__(
6365 ):
6466 """Create a BatteryPool instance.
6567
68+ !!! note
69+ `BatteryPool` instances are not meant to be created directly by users. Use
70+ the [`microgrid.battery_pool`][frequenz.sdk.microgrid.battery_pool] method
71+ for creating `BatteryPool` instances.
72+
6673 Args:
6774 battery_pool_ref: The battery pool reference store instance.
6875 name: An optional name used to identify this instance of the pool or a
You can’t perform that action at this time.
0 commit comments