Skip to content

Commit 80c4b17

Browse files
Apply suggestions from code review
Co-authored-by: Hilary James Oliver <[email protected]>
1 parent 583515d commit 80c4b17

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

src/user-guide/running-workflows/cylc-broadcast.rst

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Broadcasts can be helpful for:
1313
* Quickly developing tasks without having to
1414
:ref:`edit and reload the workflow configuration <interventions.edit-the-workflow-configuration>`.
1515
* Sending small amounts of data from a running task to other upcoming tasks (e.g. file paths).
16-
* Orchestrating production workflows from an external system.
16+
* Reconfiguring production workflows while they are running.
1717

1818
Broadcasts which target specific cycles will eventually be
1919
:ref:`expired <user_guide.broadcast.expiry>` when no longer needed.
@@ -57,8 +57,8 @@ For more information, run ``cylc broadcast --help``.
5757
GUI
5858
^^^
5959

60-
Broadcasts can also be issued from the GUI in a similar way using the
61-
"Broadcast" command.
60+
Broadcasts can also be issued from the GUI in a similar way by choosing
61+
"Broadcast" from the task menu.
6262

6363
Additionally, the GUI provides a utility called "Edit Runtime" which loads
6464
the tasks configuration into a form. Any changes you make are then broadcasted
@@ -77,22 +77,21 @@ Expiry
7777
------
7878

7979
Broadcasts which target specific cycles will eventually expire (i.e. be
80-
deleted) as the workflow moves on. Otherwise they would gradually accumulate
81-
over the life of the workflow (note broadcasts are persisted when the workflow
82-
restarts).
80+
deleted) as the workflow moves on, to avoid gradual accumulation
81+
(note broadcasts are persisted when the workflow restarts).
8382

8483

8584
Expiry Point
8685
^^^^^^^^^^^^
8786

88-
Broadcasts are only expired after they are no longer required by tasks.
87+
Broadcasts expire once are they are no longer required by upcoming tasks.
8988
The exact point at which a broadcast is expired depends on two things:
9089

9190
* The oldest cycle in the workflow to contain
9291
:term:`active tasks <active task>`.
9392
* The longest cycling :term:`recurrence` in the workflow.
9493

95-
Broadcasts which are older than the oldest cycle point to contain active tasks
94+
Broadcasts which are older than the oldest :term:`active cycle point`
9695
*minus* the duration of the longest recurrence will be cleared.
9796

9897
For example, for the following workflow:
@@ -110,8 +109,8 @@ The longest cycling recurrence is ``P3Y``.
110109
If there were no more tasks left running in the cycle ``2000``, then broadcasts
111110
for cycles earlier than ``1997`` (``2000 - P3Y``) would be expired.
112111

113-
This arrangement has been designed such that broadcasts should always be
114-
present for the previous instance of a task in case you want to re-run it.
112+
This is designed to keep broadcasts as far back as the previous instance
113+
of each task, in case you want to re-run it.
115114

116115

117116
Broadcasting To Historical Cycles
@@ -120,9 +119,9 @@ Broadcasting To Historical Cycles
120119
Broadcasts targeting historical cycles may be expired as soon as they are
121120
issued as the result of broadcast expiry.
122121

123-
Broadcast expiry does not occur while the workflow is paused. If you want to
124-
broadcast to a historical cycle before re-running it, first pause the workflow,
125-
then trigger the tasks, then resume the workflow, e.g:
122+
However, broadcast expiry does not occur while the workflow is paused, so
123+
you can pause the workflow, do the broadcast, trigger the tasks, and then
124+
resume the workflow, e.g:
126125

127126
.. code-block:: bash
128127

0 commit comments

Comments
 (0)