Skip to content

Commit 09f6ee0

Browse files
committed
Document how LogicalMeter instances should be created
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent e424139 commit 09f6ee0

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ class LogicalMeter:
3232
microgrid. These methods return `FormulaReceiver` objects, which can be used like
3333
normal `Receiver`s, but can also be composed to form higher-order formula streams.
3434
35+
!!! note
36+
`LogicalMeter` instances are not meant to be created directly by users. Use the
37+
[`microgrid.logical_meter`][frequenz.sdk.microgrid.logical_meter] method for
38+
creating `LogicalMeter` instances.
39+
3540
Example:
3641
```python
3742
from datetime import timedelta
@@ -71,7 +76,12 @@ def __init__(
7176
channel_registry: ChannelRegistry,
7277
resampler_subscription_sender: Sender[ComponentMetricRequest],
7378
) -> None:
74-
"""Create a `LogicalMeter instance`.
79+
"""Create a `LogicalMeter` instance.
80+
81+
!!! note
82+
`LogicalMeter` instances are not meant to be created directly by users. Use
83+
the [`microgrid.logical_meter`][frequenz.sdk.microgrid.logical_meter] method
84+
for creating `LogicalMeter` instances.
7585
7686
Args:
7787
channel_registry: A channel registry instance shared with the resampling

0 commit comments

Comments
 (0)