Skip to content

Commit 3667195

Browse files
fix typo (#290)
1 parent ff62cb0 commit 3667195

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

src/topics/creating-files-at-runtime.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Creating Files at Runtime
22

33
Sometimes you need to create a file on the fly from input parameters,
4-
such as tools which expect to read their input configuration from a file
4+
such as tools that expect to read their input configuration from a file
55
rather than the command line parameters, or need a small wrapper shell script.
66

7-
To generate such files we can use the `InitialWorkDirRequirement`.
7+
To generate such files, we can use the `InitialWorkDirRequirement`.
88

99
```{literalinclude} /_includes/cwl/creating-files-at-runtime/createfile.cwl
1010
:language: cwl
@@ -13,32 +13,32 @@ To generate such files we can use the `InitialWorkDirRequirement`.
1313
```
1414

1515
Any [expressions](../topics/expressions.md) like `$(inputs.message)` are
16-
expanded by the CWL engine before creating the file;
17-
here inserting the value at the input `message`.
16+
expanded by the CWL engine before creating the file.
17+
Here, insert the value at the input `message`.
1818

1919
```{tip}
2020
The _CWL expressions_ are independent of any _shell variables_
2121
used later during command line tool invocation. That means that any genuine
22-
need for the character `$` must be **escaped** with `\`,
23-
for instance `\${PREFIX}` above is expanded to `${PREFIX}` in the generated file
22+
need for the character `$` must be **escaped** with `\`.
23+
For instance, `\${PREFIX}` above is expanded to `${PREFIX}` in the generated file
2424
to be evaluated by the shell script instead of the CWL engine.
2525
```
2626

27-
To test the above CWL tool use this job to provide the input value `message`:
27+
To test the above CWL tool, use this job to provide the input value `message`:
2828

2929
```{literalinclude} /_includes/cwl/creating-files-at-runtime/echo-job.yml
3030
:language: yaml
3131
:caption: "`echo-job.yml`"
3232
:name: echo-job.yml
3333
```
3434

35-
Before we run this, lets look at each step in a little more detail.
35+
Before we run this, let us look at each step in a little more detail.
3636
The base command `baseCommand: ["sh", "example.sh"]`
3737
will execute the command `sh example.sh`.
3838
This will run the file we create in the shell.
3939

4040
`InitialWorkDirRequirement` requires a `listing`.
41-
As the `listing` is a YAML array we need a `-` on the first line of
41+
As the `listing` is a YAML array, we need a `-` on the first line of
4242
each element of the array, in this case we have just one element.
4343
`entryname:` can have any value,
4444
but it must match what was specified in the `baseCommand`.

src/topics/using-containers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ then print "Hello World" to the standard output.
3030
:name: docker-job.yml
3131
```
3232

33-
Before we run this, lets just break it down and see what some bits do. Most of this
33+
Before we run this, let's just break it down and see what some bits do. Most of this
3434
has been explained in previous sections, the only part that is really new is the `dockerRequirement`
3535
section.
3636

@@ -46,7 +46,7 @@ then need to specify some `hints` for how to find the container we want. In thi
4646
just our requirements for the docker container in `DockerRequirements`. The `dockerPull:`
4747
parameter takes the same value that you would pass to a `docker pull` command. That is,
4848
the name of the container image (you can even specify the tag, which is good idea for
49-
best practises when using containers for reproducible research). In this case we have
49+
best practices when using containers for reproducible research). In this case we have
5050
used a container called `node:slim`.
5151

5252
Provide a "hello.js" and invoke `cwltool` providing the tool description and the

0 commit comments

Comments
 (0)