Skip to content

Commit de3fbd3

Browse files
authored
Topics > Outputs: Clarifying the nature of glob; minor fixes. (#405)
- Make it clear that `glob` is a pattern (that can happen to be a file name). - Minor fixes for grammar and clarity.
1 parent 7e53fe4 commit de3fbd3

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/topics/outputs.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,18 @@ When a tool runs under CWL, the starting working directory is the
1111
designated output directory. The underlying tool or script must record
1212
its results in the form of files created in the output directory. The
1313
output parameters returned by the CWL tool are either the output files
14-
themselves, or come from examining the content of those files.
14+
themselves, or the result of examining the content of those files.
1515

1616
The following example demonstrates how to return a file that has been extracted from a tar file.
1717

1818
```{tip}
1919
Passing mandatory arguments to the `baseCommand`
2020
21-
In previous examples, the `baseCommand` was just a string, with any arguments passed as CWL inputs.
22-
Instead of a single string we can use an _array of strings_. The first element is the command to run, and
23-
any subsequent elements are mandatory command line arguments
21+
In previous examples, the `baseCommand` was just a string, with any arguments
22+
passed as CWL inputs. Instead of a single string, we can use an _array of
23+
strings_ as the value of `baseCommand`. The first element of the array is the
24+
command to run, and any subsequent elements are mandatory command line
25+
arguments
2426
```
2527

2628
```{literalinclude} /_includes/cwl/outputs/tar.cwl
@@ -59,8 +61,10 @@ outputs:
5961
glob: hello.txt
6062
```
6163

62-
The [`glob`](https://w3id.org/cwl/CommandLineTool.html#CommandOutputBinding) field consists of the name of a file in the output directory.
63-
If you don't know name of the file in advance, you can use a wildcard pattern like `glob: '*.txt'`.
64+
The [`glob`](https://w3id.org/cwl/CommandLineTool.html#CommandOutputBinding)
65+
field consists of the pattern to match file names in the output directory.
66+
This can simply be the file's exact name. But if you don't know the name of the
67+
file in advance, you can use a wildcard pattern like `glob: '*.txt'`.
6468

6569
## Capturing Standard Output
6670

0 commit comments

Comments
 (0)