Skip to content

Commit f22f861

Browse files
committed
Improve wording
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent f7d4345 commit f22f861

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/frequenz/sdk/actor/__init__.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ class communicates through message passing. Even when no particular message pass
4444
[`Actor`][frequenz.sdk.actor.Actor] class handles task cancellation and cleanup.
4545
4646
- **Simplified lifecycle management:** Actors are [async context managers] and also
47-
a [`run()`][frequenz.sdk.actor.run] function is provided.
47+
a [`run()`][frequenz.sdk.actor.run] function is provided to easily run a group of
48+
actors and wait for them to finish.
4849
4950
## Lifecycle
5051
@@ -84,7 +85,7 @@ async def _run(self) -> None:
8485
await run(MyActor()) # (1)!
8586
```
8687
87-
1. Will block until the actor is stopped.
88+
1. This line will block until the actor is stopped.
8889
8990
### Async Context Manager
9091
@@ -143,7 +144,7 @@ async def _run(self) -> None:
143144
!!! warning
144145
145146
This method is not recommended because it is easy to forget to stop the actor
146-
manually, specially in error conditions.
147+
manually, especially in error conditions.
147148
148149
## Communication
149150
@@ -249,8 +250,9 @@ async def _extra_task(self) -> None:
249250
250251
!!! tip
251252
252-
The code examples are annotated with markers (like {{code_annotation_marker}}), they
253-
explain step-by-step what's going on in order of execution.
253+
The code examples are annotated with markers (like {{code_annotation_marker}}), you
254+
can click on them to see the step-by-step explanation of what's going on. The
255+
annotations are numbered according to the order of execution.
254256
255257
#### Composing actors
256258

0 commit comments

Comments
 (0)