Skip to content

Commit dbeb91c

Browse files
authored
Operations: Don't imply an operation is straightforwardly useable (#404)
The doc says "[An operation] can be used like use a command line tool or an expression", which may be read as "you can use an (abstract) operation just like how you use a (concrete) command line tool or expression". This is of course false and directly contradicted by the next example. To avoid this implication, reword it as "it can appear...". Also, a minor clarification about "Sphinx Graphviz", which referred to a specific processing directive in the Sphinx doc.
1 parent de3fbd3 commit dbeb91c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/topics/operations.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ you are ready to submit the workflow to a CWL runner:
1313
:caption: "`operations.cwl`"
1414
```
1515

16-
The `uppercase` step of the workflow is an operation. It can be used like
17-
a command line tool or an expression. You can also plot it with the
16+
The `uppercase` step of the workflow is an operation. It can appear where a
17+
command line tool or an expression is expected. You can also plot it with the
1818
CWL Viewer or `cwltool`:
1919

2020
```{runcmd} cwltool --print-dot operations.cwl
2121
:working-directory: src/_includes/cwl/operations/
2222
```
2323

24-
The output of the command above can be rendered with a Graphviz renderer. The following
25-
image is rendered with the Sphinx Graphviz directive (this user guide is built with Sphinx):
24+
The output of the command above can be rendered with a Graphviz renderer. The
25+
following image is rendered with the Sphinx `{graphviz}` directive (this user
26+
guide is built with Sphinx):
2627

2728
```{graphviz}
2829

0 commit comments

Comments
 (0)