Skip to content

Commit a7a7131

Browse files
committed
Use a more human-friendly format for the admonitions
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 71b5fc5 commit a7a7131

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

src/frequenz/core/asyncio.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ class Service(abc.ABC):
5959
[`stop()`][frequenz.core.asyncio.Service.stop] method, as the base
6060
implementation does not collect any results and re-raises all exceptions.
6161
62-
!!! warning
63-
62+
Warning:
6463
As services manage [`asyncio.Task`][] objects, a reference to them must be held
6564
for as long as the service is expected to be running, otherwise its tasks will
6665
be cancelled and the service will stop. For more information, please refer to
@@ -130,8 +129,7 @@ def tasks(self) -> collections.abc.Set[asyncio.Task[Any]]:
130129
Users typically should not modify the tasks in the returned set and only use
131130
them for informational purposes.
132131
133-
!!! danger
134-
132+
Danger:
135133
Changing the returned tasks may lead to unexpected behavior, don't do it
136134
unless the class explicitly documents it is safe to do so.
137135
"""

0 commit comments

Comments
 (0)