Skip to content

Commit beb2b6e

Browse files
committed
Update the frequenz-channels-python objects inventory
This is to match the current version being used. We also adjust some cross-references in the documentation to match the new version. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 523d506 commit beb2b6e

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ plugins:
114114
import:
115115
# See https://mkdocstrings.github.io/python/usage/#import for details
116116
- https://docs.python.org/3/objects.inv
117-
- https://frequenz-floss.github.io/frequenz-channels-python/v0.16/objects.inv
117+
- https://frequenz-floss.github.io/frequenz-channels-python/v1.1/objects.inv
118118
- https://frequenz-floss.github.io/frequenz-client-microgrid-python/v0.4/objects.inv
119119
- https://networkx.org/documentation/stable/objects.inv
120120
- https://numpy.org/doc/stable/objects.inv

src/frequenz/sdk/actor/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ async def main() -> None: # (2)!
454454
455455
This example shows how to create an actor that receives messages from multiple
456456
[broadcast][frequenz.channels.Broadcast] channels using
457-
[`select()`][frequenz.channels.util.select].
457+
[`select()`][frequenz.channels.select].
458458
459459
```python title="select.py"
460460
import asyncio
@@ -530,7 +530,7 @@ async def main() -> None: # (6)!
530530
them to another channel.
531531
532532
2. We implement the [`_run()`][_run] method that will receive messages from the two
533-
channels using [`select()`][frequenz.channels.util.select] and send them to the
533+
channels using [`select()`][frequenz.channels.select] and send them to the
534534
output channel. The `run()` method will stop if a `False` message is received.
535535
536536
3. We create the channels that will be used with the actor.
@@ -551,20 +551,20 @@ async def main() -> None: # (6)!
551551
9. We start the actor and wait for it to finish using the
552552
[`run()`][frequenz.sdk.actor.run] function.
553553
554-
10. The [`select()`][frequenz.channels.util.select] function will get the first message
554+
10. The [`select()`][frequenz.channels.select] function will get the first message
555555
available from the two channels. The order in which they will be handled is
556556
unknown, but in this example we assume that the first message will be from
557557
`input_channel_1` (`True`) and the second from `input_channel_1` (`False`).
558558
559-
11. The [`selected_from()`][frequenz.channels.util.selected_from] function will return
559+
11. The [`selected_from()`][frequenz.channels.selected_from] function will return
560560
`True` for the `input_channel_1` receiver. `selected.value` holds the received
561561
message, so `"Received from receiver_1: True"` will be printed and `True` will be
562562
sent to the `output` channel.
563563
564564
12. Since `selected.value` is `True`, the loop will continue, going back to the
565-
[`select()`][frequenz.channels.util.select] function.
565+
[`select()`][frequenz.channels.select] function.
566566
567-
13. The [`selected_from()`][frequenz.channels.util.selected_from] function will return
567+
13. The [`selected_from()`][frequenz.channels.selected_from] function will return
568568
`False` for the `input_channel_1` receiver and `True` for the `input_channel_2`
569569
receiver. The message stored in `selected.value` will now be `False`, so
570570
`"Received from receiver_2: False"` will be printed and `False` will be sent to the

0 commit comments

Comments
 (0)