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

Rocoto Docs Typo Fix #638

Merged
merged 1 commit into from
Oct 29, 2024
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
8 changes: 4 additions & 4 deletions docs/sections/user_guide/yaml/rocoto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Let's dissect the following task example:
walltime: 00:01:00
envars:
person: siri
dependencies:
dependency:

Each task is named by its UW YAML key. Blocks under ``tasks:`` prefixed with ``task_`` will be named with what follows the prefix. In the example above the task will be named ``hello`` and will appear in the XML like this:

Expand All @@ -157,7 +157,7 @@ The name of the task can be any string accepted by Rocoto as a task name (includ
<value>siri</value>
</envar>

``dependencies:`` -- [Optional] Any number of dependencies accepted by Rocoto. This section is described in more detail below.
``dependency:`` -- [Optional] Any number of dependencies accepted by Rocoto. This section is described in more detail below.

The other keys not specifically mentioned here follow the same conventions as described in the :rocoto:`Rocoto<>` documentation.

Expand All @@ -180,7 +180,7 @@ Each of the dependencies that requires attributes (the ``key="value"`` parts ins
...
task_goodbye:
command: "goodbye"
dependencies:
dependency:
taskdep:
attrs:
task: hello
Expand Down Expand Up @@ -209,7 +209,7 @@ Because UW YAML represents a hash table (a dictionary in Python), each key at th
task_hello:
command: "hello world"
...
dependencies:
dependency:
and:
datadep_foo:
value: "foo.txt"
Expand Down
Loading