From b44c5cf5c87ecf9dcb33be97f7b6fc242cce9549 Mon Sep 17 00:00:00 2001 From: Thomas Coleman Date: Thu, 9 May 2019 10:50:23 +1000 Subject: [PATCH] Fix \ in doco when wrapped in ``..`` When text is wrapped in ``..`` tags, it appears to not need to have the \ character. Everywhere else it is required though. --- doc/src/appendices/suiterc-config-ref.rst | 28 +++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/src/appendices/suiterc-config-ref.rst b/doc/src/appendices/suiterc-config-ref.rst index 86d09425510..623b88b87d8 100644 --- a/doc/src/appendices/suiterc-config-ref.rst +++ b/doc/src/appendices/suiterc-config-ref.rst @@ -73,7 +73,7 @@ A group name for a suite. [meta] ``->`` \_\_MANY\_\_ ^^^^^^^^^^^^^^^^^^^^^^^^^^ -Replace \_\_MANY\_\_ with any user-defined metadata item. These, like +Replace ``__MANY__`` with any user-defined metadata item. These, like title, URL, etc. can be passed to suite event handlers to be interpreted according to your needs. For example, "suite-priority". @@ -573,7 +573,7 @@ task event handlers. [cylc] ``->`` [[environment]] ``->`` \_\_VARIABLE\_\_ """"""""""""""""""""""""""""""""""""""""""""""""""""" -Replace ``\_\_VARIABLE\_\_`` with any number of environment variable +Replace ``__VARIABLE__`` with any number of environment variable assignment expressions. Values may refer to other local environment variables (order of definition is preserved) and are not evaluated or manipulated by @@ -982,7 +982,7 @@ See also :ref:`InternalQueues`. """"""""""""""""""""""""""""""""""""""""""""""""""""""""" Section heading for configuration of a single queue. Replace -``\_\_QUEUE\_\_`` with a queue name, and repeat the section as required. +``__QUEUE__`` with a queue name, and repeat the section as required. - *type*: string - *default*: "default" @@ -1017,7 +1017,7 @@ see :ref:`External Triggers`. [scheduling] ``->`` [[xtriggers]] ``->`` \_\_MANY\_\_ """"""""""""""""""""""""""""""""""""""""""""""""""""" -Replace ``\_\_MANY\_\_`` with any user-defined event trigger function +Replace ``__MANY__`` with any user-defined event trigger function declarations and corresponding labels for use in the graph: - *type*: string: function signature followed by optional call interval @@ -1173,7 +1173,7 @@ string syntax. [scheduling] ``->`` [[dependencies]] ``->`` [[[\_\_RECURRENCE\_\_]]] """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -``\_\_RECURRENCE\_\_`` section headings define the sequence of cycle points for +``__RECURRENCE__`` section headings define the sequence of cycle points for which the subsequent graph section is valid. These should be specified in our ISO 8601 derived sequence syntax, or similar for integer cycling: @@ -1234,7 +1234,7 @@ hierarchies. For details and examples see :ref:`NIORP`. [runtime] ``->`` [[\_\_NAME\_\_]] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Replace ``\_\_NAME\_\_`` with a namespace name, or a comma-separated list of +Replace ``__NAME__`` with a namespace name, or a comma-separated list of names, and repeat as needed to define all tasks in the suite. Names may contain letters, digits, underscores, and hyphens. A namespace represents a group or family of tasks if other namespaces inherit from @@ -1490,7 +1490,7 @@ See also :ref:`SuiteURL`. [runtime] ``->`` [[\_\_NAME\_\_]] ``->`` [[[meta]]] ``->`` \_\_MANY\_\_ ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Replace ``\_\_MANY\_\_`` with any user-defined metadata item. These, like title, +Replace ``__MANY__`` with any user-defined metadata item. These, like title, URL, etc. can be passed to task event handlers to be interpreted according to your needs. For example, the value of an "importance" item could determine how an event handler responds to task failure events. @@ -1993,7 +1993,7 @@ earlier in the script. See also :ref:`TaskExecutionEnvironment`. [runtime] ``->`` [[\_\_NAME\_\_]] ``->`` [[[environment]]] ``->`` \_\_VARIABLE\_\_ '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Replace ``\_\_VARIABLE\_\_`` with any number of environment variable +Replace ``__VARIABLE__`` with any number of environment variable assignment expressions. Order of definition is preserved so values can refer to previously defined variables. Values are passed through to the task job script without evaluation or manipulation by cylc, so any variable assignment @@ -2070,11 +2070,11 @@ relevant for *parameterized tasks* - see :ref:`Parameterized Tasks Label`. [runtime] ``->`` [[\_\_NAME\_\_]] ``->`` [[[parameter environment templates]]] ``->`` \_\_VARIABLE\_\_ '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Replace ``\_\_VARIABLE\_\_`` with pairs of environment variable +Replace ``__VARIABLE__`` with pairs of environment variable name and Python string template for parameter substitution. This is only relevant for *parameterized tasks* - see :ref:`Parameterized Tasks Label`. -If specified, in addition to the standard ``CYLC\_TASK\_PARAM\_`` +If specified, in addition to the standard ``CYLC_TASK_PARAM_`` variables, the job script will also export the named variables specified here, with the template strings substituted with the parameter values. @@ -2103,7 +2103,7 @@ individually overridden at lower levels of the runtime namespace hierarchy. [runtime] ``->`` [[\_\_NAME\_\_]] ``->`` [[[directives]]] ``->`` \_\_DIRECTIVE\_\_ '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Replace ``\_\_DIRECTIVE\_\_`` with each directive assignment, e.g. +Replace ``__DIRECTIVE__`` with each directive assignment, e.g. ``class = parallel``. - *type*: string @@ -2123,7 +2123,7 @@ Register custom task outputs for use in message triggering in this section [runtime] ``->`` [[\_\_NAME\_\_]] ``->`` [[[outputs]]] ``->`` \_\_OUTPUT\_\_ '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Replace ``\_\_OUTPUT\_\_`` with one or more custom task output messages +Replace ``__OUTPUT__`` with one or more custom task output messages (:ref:`MessageTriggers`). The item name is used to select the custom output message in graph trigger notation. @@ -2431,7 +2431,7 @@ root, so you can style family and member nodes at once by family name. [visualization] ``->`` [[node groups]] ``->`` __GROUP__ """"""""""""""""""""""""""""""""""""""""""""""""""""""" -Replace ``\_\_GROUP\_\_`` with each named group of tasks or families. +Replace ``__GROUP__`` with each named group of tasks or families. - *type*: Comma-separated list of task or family names. - *default*: (none) @@ -2458,7 +2458,7 @@ override the earlier green styling of the member. [visualization] ``->`` [[node attributes]] ``->`` \_\_NAME\_\_ """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" -Replace ``\_\_NAME\_\_`` with each node or node group for style attribute +Replace ``__NAME__`` with each node or node group for style attribute assignment. - *type*: Comma-separated list of quoted ``'attribute=value'`` pairs.