Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix \ in doco when wrapped in .. #3158

Merged
merged 1 commit into from
May 9, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions doc/src/appendices/suiterc-config-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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".

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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\_<key>``
If specified, in addition to the standard ``CYLC_TASK_PARAM_<key>``
variables, the job script will also export the named variables specified
here, with the template strings substituted with the parameter values.

Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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)
Expand All @@ -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.
Expand Down