Skip to content

Commit 02a1057

Browse files
Deployed 195a93c to v1.2-dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 15f3822 commit 02a1057

File tree

6 files changed

+392
-271
lines changed

6 files changed

+392
-271
lines changed
0 Bytes
Binary file not shown.

v1.2-dev/reference/frequenz/channels/file_watcher/index.html

Lines changed: 301 additions & 268 deletions
Large diffs are not rendered by default.

v1.2-dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

v1.2-dev/sitemap.xml.gz

0 Bytes
Binary file not shown.

v1.2-dev/user-guide/utilities/file-watchers/index.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1410,7 +1410,18 @@ <h2 id="frequenz.channels.file_watcher.FileWatcher--usage">Usage<a class="header
14101410
<a class="autorefs autorefs-internal" href="../../../reference/frequenz/channels/file_watcher/#frequenz.channels.file_watcher.Event.type"><code>type</code></a> of change that was observed and
14111411
the <a class="autorefs autorefs-internal" href="../../../reference/frequenz/channels/file_watcher/#frequenz.channels.file_watcher.Event.path"><code>path</code></a> where the change was
14121412
observed.</p>
1413-
<h2 id="frequenz.channels.file_watcher.FileWatcher--event-types">Event Types<a class="headerlink" href="#frequenz.channels.file_watcher.FileWatcher--event-types" title="Permanent link">¤</a></h2>
1413+
1414+
1415+
<details class="note" open>
1416+
<summary>Note</summary>
1417+
<p>The owner of the <a class="autorefs autorefs-internal" href="../../../reference/frequenz/channels/file_watcher/#frequenz.channels.file_watcher.FileWatcher"><code>FileWatcher</code></a>
1418+
receiver is responsible for recreating the <code>FileWatcher</code> after it has been
1419+
cancelled or stopped.
1420+
For example, if a <a class="autorefs autorefs-external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task"><code>Task</code></a> uses an asynchronous iterator to consume
1421+
events from the <code>FileWatcher</code> and the task is cancelled, the <code>FileWatcher</code> will
1422+
also stop. Therefore, the same <code>FileWatcher</code> instance cannot be reused for a new
1423+
task to consume events. In this case, a new FileWatcher instance must be created.</p>
1424+
</details> <h2 id="frequenz.channels.file_watcher.FileWatcher--event-types">Event Types<a class="headerlink" href="#frequenz.channels.file_watcher.FileWatcher--event-types" title="Permanent link">¤</a></h2>
14141425
<p>The following event types are available:</p>
14151426
<ul>
14161427
<li><a class="autorefs autorefs-internal" href="../../../reference/frequenz/channels/file_watcher/#frequenz.channels.file_watcher.EventType.CREATE"><code>CREATE</code></a>:

versions.json

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,78 @@
1-
[{"version":"v1.2-dev","title":"v1.2-dev (6d1769f)","aliases":["v1-dev","latest-dev"]},{"version":"v1.1-dev","title":"v1.1-dev (779e807)","aliases":[]},{"version":"v1.1","title":"v1.1.1","aliases":["v1","latest"]},{"version":"v1.0-dev","title":"v1.0-dev (d9b7d22)","aliases":[]},{"version":"v1.0","title":"v1.0.1","aliases":[]},{"version":"v1.0-pre","title":"v1.0.0-rc.1","aliases":["v1-pre","latest-pre"]},{"version":"v0.16","title":"v0.16.0","aliases":["v0"]},{"version":"v0.15","title":"v0.15.1","aliases":[]},{"version":"v0.14","title":"v0.14.0","aliases":[]},{"version":"v0.13","title":"v0.13.0","aliases":[]},{"version":"v0.12","title":"v0.12.0","aliases":[]},{"version":"v0.11","title":"v0.11.0","aliases":[]},{"version":"v0.10","title":"v0.10.1","aliases":[]}]
1+
[
2+
{
3+
"version": "v1.2-dev",
4+
"title": "v1.2-dev (195a93c)",
5+
"aliases": [
6+
"latest-dev",
7+
"v1-dev"
8+
]
9+
},
10+
{
11+
"version": "v1.1",
12+
"title": "v1.1.1",
13+
"aliases": [
14+
"v1",
15+
"latest"
16+
]
17+
},
18+
{
19+
"version": "v1.1-dev",
20+
"title": "v1.1-dev (779e807)",
21+
"aliases": []
22+
},
23+
{
24+
"version": "v1.0",
25+
"title": "v1.0.1",
26+
"aliases": []
27+
},
28+
{
29+
"version": "v1.0-pre",
30+
"title": "v1.0.0-rc.1",
31+
"aliases": [
32+
"v1-pre",
33+
"latest-pre"
34+
]
35+
},
36+
{
37+
"version": "v1.0-dev",
38+
"title": "v1.0-dev (d9b7d22)",
39+
"aliases": []
40+
},
41+
{
42+
"version": "v0.16",
43+
"title": "v0.16.0",
44+
"aliases": [
45+
"v0"
46+
]
47+
},
48+
{
49+
"version": "v0.15",
50+
"title": "v0.15.1",
51+
"aliases": []
52+
},
53+
{
54+
"version": "v0.14",
55+
"title": "v0.14.0",
56+
"aliases": []
57+
},
58+
{
59+
"version": "v0.13",
60+
"title": "v0.13.0",
61+
"aliases": []
62+
},
63+
{
64+
"version": "v0.12",
65+
"title": "v0.12.0",
66+
"aliases": []
67+
},
68+
{
69+
"version": "v0.11",
70+
"title": "v0.11.0",
71+
"aliases": []
72+
},
73+
{
74+
"version": "v0.10",
75+
"title": "v0.10.1",
76+
"aliases": []
77+
}
78+
]

0 commit comments

Comments
 (0)