Skip to content

Commit fc5f14c

Browse files
committed
added documentation for <param><param2> syntax
1 parent 84bb4b5 commit fc5f14c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/user-guide/writing-workflows/parameterized-tasks.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,23 @@ template syntax.
106106

107107
Any number of parameters can be used at once. This parameterization:
108108

109+
109110
.. code-block:: sub
110111
111112
model<run,obs> # for run = 1..2 and obs = ship, buoy, plane
113+
model<run><obs> # Alternatively, from Cylc 8.2.0
114+
115+
.. versionadded:: 8.2.0
116+
117+
From this version you can also use the equivalent ``model<run><obs>``
118+
syntax. This allows more flexibility in templating: You can now construct
119+
names like ``beginning<run>middle<obs>end``.
120+
121+
.. note::
122+
123+
Before Cylc 8.2.0 this syntax worked in many cases, but was
124+
not formally supported, and failed if used in the names of
125+
:ref:`task families<taskfamilies.parameters>`.
112126

113127
expands to these tasks names:
114128

@@ -369,6 +383,7 @@ expands to:
369383
370384
proc_small => proc_big => proc_huge
371385
386+
.. _taskfamilies.parameters:
372387

373388
Task Families and Parameters
374389
----------------------------

0 commit comments

Comments
 (0)