Skip to content

Commit a710e05

Browse files
committed
Remove mention of Peekables from docs in MicrogridApiClient
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent f9d0797 commit a710e05

File tree

1 file changed

+0
-32
lines changed

1 file changed

+0
-32
lines changed

src/frequenz/sdk/microgrid/client/_client.py

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,6 @@ async def meter_data(
9898
) -> Receiver[MeterData]:
9999
"""Return a channel receiver that provides a `MeterData` stream.
100100
101-
If only the latest value is required, the `Receiver` returned by this
102-
method can be converted into a `Peekable` with the `into_peekable`
103-
method on the `Receiver.`
104-
105101
Args:
106102
component_id: id of the meter to get data for.
107103
maxsize: Size of the receiver's buffer.
@@ -118,10 +114,6 @@ async def battery_data(
118114
) -> Receiver[BatteryData]:
119115
"""Return a channel receiver that provides a `BatteryData` stream.
120116
121-
If only the latest value is required, the `Receiver` returned by this
122-
method can be converted into a `Peekable` with the `into_peekable`
123-
method on the `Receiver.`
124-
125117
Args:
126118
component_id: id of the battery to get data for.
127119
maxsize: Size of the receiver's buffer.
@@ -138,10 +130,6 @@ async def inverter_data(
138130
) -> Receiver[InverterData]:
139131
"""Return a channel receiver that provides an `InverterData` stream.
140132
141-
If only the latest value is required, the `Receiver` returned by this
142-
method can be converted into a `Peekable` with the `into_peekable`
143-
method on the `Receiver.`
144-
145133
Args:
146134
component_id: id of the inverter to get data for.
147135
maxsize: Size of the receiver's buffer.
@@ -158,10 +146,6 @@ async def ev_charger_data(
158146
) -> Receiver[EVChargerData]:
159147
"""Return a channel receiver that provides an `EvChargeData` stream.
160148
161-
If only the latest value is required, the `Receiver` returned by this
162-
method can be converted into a `Peekable` with the `into_peekable`
163-
method on the `Receiver.`
164-
165149
Args:
166150
component_id: id of the ev charger to get data for.
167151
maxsize: Size of the receiver's buffer.
@@ -493,10 +477,6 @@ async def meter_data( # noqa: DOC502 (ValueError is raised indirectly by _expec
493477
) -> Receiver[MeterData]:
494478
"""Return a channel receiver that provides a `MeterData` stream.
495479
496-
If only the latest value is required, the `Receiver` returned by this
497-
method can be converted into a `Peekable` with the `into_peekable`
498-
method on the `Receiver.`
499-
500480
Raises:
501481
ValueError: if the given id is unknown or has a different type.
502482
@@ -523,10 +503,6 @@ async def battery_data( # noqa: DOC502 (ValueError is raised indirectly by _exp
523503
) -> Receiver[BatteryData]:
524504
"""Return a channel receiver that provides a `BatteryData` stream.
525505
526-
If only the latest value is required, the `Receiver` returned by this
527-
method can be converted into a `Peekable` with the `into_peekable`
528-
method on the `Receiver.`
529-
530506
Raises:
531507
ValueError: if the given id is unknown or has a different type.
532508
@@ -553,10 +529,6 @@ async def inverter_data( # noqa: DOC502 (ValueError is raised indirectly by _ex
553529
) -> Receiver[InverterData]:
554530
"""Return a channel receiver that provides an `InverterData` stream.
555531
556-
If only the latest value is required, the `Receiver` returned by this
557-
method can be converted into a `Peekable` with the `into_peekable`
558-
method on the `Receiver.`
559-
560532
Raises:
561533
ValueError: if the given id is unknown or has a different type.
562534
@@ -583,10 +555,6 @@ async def ev_charger_data( # noqa: DOC502 (ValueError is raised indirectly by _
583555
) -> Receiver[EVChargerData]:
584556
"""Return a channel receiver that provides an `EvChargeData` stream.
585557
586-
If only the latest value is required, the `Receiver` returned by this
587-
method can be converted into a `Peekable` with the `into_peekable`
588-
method on the `Receiver.`
589-
590558
Raises:
591559
ValueError: if the given id is unknown or has a different type.
592560

0 commit comments

Comments
 (0)